[ros-diffs] [reactos] 01/01: [SHLWAPI] Add G. Chappell's documentation links (#5515)

[Katayama Hirofumi MZ]

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=6bc864acac87804be07c5…

commit 6bc864acac87804be07c5866fbea498b5124b570
Author:     Katayama Hirofumi MZ <katayama.hirofumi.mz(a)gmail.com>
AuthorDate: Thu Aug 3 20:48:58 2023 +0900
Commit:     GitHub <noreply(a)github.com>
CommitDate: Thu Aug 3 20:48:58 2023 +0900

    [SHLWAPI] Add G. Chappell's documentation links (#5515)
    
    Add comments to SHPropertyBag_... functions. CORE-9283
---
 dll/win32/shlwapi/ordinal.c | 49 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/dll/win32/shlwapi/ordinal.c b/dll/win32/shlwapi/ordinal.c
index 3599e723011..9053c33b956 100644
--- a/dll/win32/shlwapi/ordinal.c
+++ b/dll/win32/shlwapi/ordinal.c
@@ -5382,6 +5382,8 @@ VariantArrayToBuffer(
 
 /**************************************************************************
  *  SHPropertyBag_ReadType (SHLWAPI.493)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/rea…
  */
 HRESULT WINAPI
 SHPropertyBag_ReadType(IPropertyBag *ppb, LPCWSTR pszPropName, VARIANTARG *pvarg, VARTYPE
vt)
@@ -5404,6 +5406,8 @@ SHPropertyBag_ReadType(IPropertyBag *ppb, LPCWSTR pszPropName,
VARIANTARG *pvarg
 
 /**************************************************************************
  *  SHPropertyBag_ReadBOOL (SHLWAPI.534)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/rea…
  */
 HRESULT WINAPI SHPropertyBag_ReadBOOL(IPropertyBag *ppb, LPCWSTR pszPropName, BOOL
*pbValue)
 {
@@ -5427,6 +5431,8 @@ HRESULT WINAPI SHPropertyBag_ReadBOOL(IPropertyBag *ppb, LPCWSTR
pszPropName, BO
 
 /**************************************************************************
  *  SHPropertyBag_ReadBOOLOld (SHLWAPI.498)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/rea…
  */
 BOOL WINAPI SHPropertyBag_ReadBOOLOld(IPropertyBag *ppb, LPCWSTR pszPropName, BOOL
bDefValue)
 {
@@ -5444,6 +5450,8 @@ BOOL WINAPI SHPropertyBag_ReadBOOLOld(IPropertyBag *ppb, LPCWSTR
pszPropName, BO
 
 /**************************************************************************
  *  SHPropertyBag_ReadSHORT (SHLWAPI.527)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/rea…
  */
 HRESULT WINAPI SHPropertyBag_ReadSHORT(IPropertyBag *ppb, LPCWSTR pszPropName, SHORT
*psValue)
 {
@@ -5478,6 +5486,9 @@ HRESULT WINAPI SHPropertyBag_ReadSHORT(IPropertyBag *ppb, LPCWSTR
pszPropName, S
  *
  * RETURNS
  *  HRESULT codes
+#ifdef __REACTOS__
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/rea…
+#endif
  */
 HRESULT WINAPI SHPropertyBag_ReadLONG(IPropertyBag *ppb, LPCWSTR pszPropName, LPLONG
pValue)
 {
@@ -5518,6 +5529,8 @@ HRESULT WINAPI SHPropertyBag_ReadLONG(IPropertyBag *ppb, LPCWSTR
pszPropName, LP
 #ifdef __REACTOS__
 /**************************************************************************
  *  SHPropertyBag_ReadDWORD (SHLWAPI.507)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/rea…
  */
 HRESULT WINAPI SHPropertyBag_ReadDWORD(IPropertyBag *ppb, LPCWSTR pszPropName, DWORD
*pdwValue)
 {
@@ -5541,6 +5554,8 @@ HRESULT WINAPI SHPropertyBag_ReadDWORD(IPropertyBag *ppb, LPCWSTR
pszPropName, D
 
 /**************************************************************************
  *  SHPropertyBag_ReadBSTR (SHLWAPI.520)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/rea…
  */
 HRESULT WINAPI SHPropertyBag_ReadBSTR(IPropertyBag *ppb, LPCWSTR pszPropName, BSTR
*pbstr)
 {
@@ -5566,6 +5581,8 @@ HRESULT WINAPI SHPropertyBag_ReadBSTR(IPropertyBag *ppb, LPCWSTR
pszPropName, BS
 
 /**************************************************************************
  *  SHPropertyBag_ReadStr (SHLWAPI.494)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/rea…
  */
 HRESULT WINAPI SHPropertyBag_ReadStr(IPropertyBag *ppb, LPCWSTR pszPropName, LPWSTR
pszDst, int cchMax)
 {
@@ -5591,6 +5608,8 @@ HRESULT WINAPI SHPropertyBag_ReadStr(IPropertyBag *ppb, LPCWSTR
pszPropName, LPW
 
 /**************************************************************************
  *  SHPropertyBag_ReadPOINTL (SHLWAPI.521)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/rea…
  */
 HRESULT WINAPI SHPropertyBag_ReadPOINTL(IPropertyBag *ppb, LPCWSTR pszPropName, POINTL
*pptl)
 {
@@ -5629,6 +5648,8 @@ HRESULT WINAPI SHPropertyBag_ReadPOINTL(IPropertyBag *ppb, LPCWSTR
pszPropName,
 
 /**************************************************************************
  *  SHPropertyBag_ReadPOINTS (SHLWAPI.525)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/rea…
  */
 HRESULT WINAPI SHPropertyBag_ReadPOINTS(IPropertyBag *ppb, LPCWSTR pszPropName, POINTS
*ppts)
 {
@@ -5654,6 +5675,8 @@ HRESULT WINAPI SHPropertyBag_ReadPOINTS(IPropertyBag *ppb, LPCWSTR
pszPropName,
 
 /**************************************************************************
  *  SHPropertyBag_ReadRECTL (SHLWAPI.523)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/rea…
  */
 HRESULT WINAPI SHPropertyBag_ReadRECTL(IPropertyBag *ppb, LPCWSTR pszPropName, RECTL
*prcl)
 {
@@ -5702,6 +5725,8 @@ HRESULT WINAPI SHPropertyBag_ReadRECTL(IPropertyBag *ppb, LPCWSTR
pszPropName, R
 
 /**************************************************************************
  *  SHPropertyBag_ReadGUID (SHLWAPI.505)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/rea…
  */
 HRESULT WINAPI SHPropertyBag_ReadGUID(IPropertyBag *ppb, LPCWSTR pszPropName, GUID
*pguid)
 {
@@ -5744,6 +5769,8 @@ HRESULT WINAPI SHPropertyBag_ReadGUID(IPropertyBag *ppb, LPCWSTR
pszPropName, GU
 
 /**************************************************************************
  *  SHPropertyBag_ReadStream (SHLWAPI.531)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/rea…
  */
 HRESULT WINAPI SHPropertyBag_ReadStream(IPropertyBag *ppb, LPCWSTR pszPropName, IStream
**ppStream)
 {
@@ -5770,6 +5797,8 @@ HRESULT WINAPI SHPropertyBag_ReadStream(IPropertyBag *ppb, LPCWSTR
pszPropName,
 
 /**************************************************************************
  *  SHPropertyBag_Delete (SHLWAPI.535)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/del…
  */
 HRESULT WINAPI SHPropertyBag_Delete(IPropertyBag *ppb, LPCWSTR pszPropName)
 {
@@ -5789,6 +5818,8 @@ HRESULT WINAPI SHPropertyBag_Delete(IPropertyBag *ppb, LPCWSTR
pszPropName)
 
 /**************************************************************************
  *  SHPropertyBag_WriteBOOL (SHLWAPI.499)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/wri…
  */
 HRESULT WINAPI SHPropertyBag_WriteBOOL(IPropertyBag *ppb, LPCWSTR pszPropName, BOOL
bValue)
 {
@@ -5809,6 +5840,8 @@ HRESULT WINAPI SHPropertyBag_WriteBOOL(IPropertyBag *ppb, LPCWSTR
pszPropName, B
 
 /**************************************************************************
  *  SHPropertyBag_WriteSHORT (SHLWAPI.528)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/wri…
  */
 HRESULT WINAPI SHPropertyBag_WriteSHORT(IPropertyBag *ppb, LPCWSTR pszPropName, SHORT
sValue)
 {
@@ -5831,6 +5864,8 @@ HRESULT WINAPI SHPropertyBag_WriteSHORT(IPropertyBag *ppb, LPCWSTR
pszPropName,
  *  SHPropertyBag_WriteLONG (SHLWAPI.497)
  *
  * This function asks a property bag to write a named property as a LONG.
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/wri…
  */
 HRESULT WINAPI SHPropertyBag_WriteLONG(IPropertyBag *ppb, LPCWSTR pszPropName, LONG
lValue)
 {
@@ -5851,6 +5886,8 @@ HRESULT WINAPI SHPropertyBag_WriteLONG(IPropertyBag *ppb, LPCWSTR
pszPropName, L
 
 /**************************************************************************
  *  SHPropertyBag_WriteDWORD (SHLWAPI.508)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/wri…
  */
 HRESULT WINAPI SHPropertyBag_WriteDWORD(IPropertyBag *ppb, LPCWSTR pszPropName, DWORD
dwValue)
 {
@@ -5873,6 +5910,8 @@ HRESULT WINAPI SHPropertyBag_WriteDWORD(IPropertyBag *ppb, LPCWSTR
pszPropName,
  *  SHPropertyBag_WriteStr (SHLWAPI.495)
  *
  * This function asks a property bag to write a string as the value of a named property.
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/wri…
  */
 HRESULT WINAPI SHPropertyBag_WriteStr(IPropertyBag *ppb, LPCWSTR pszPropName, LPCWSTR
pszValue)
 {
@@ -5900,6 +5939,8 @@ HRESULT WINAPI SHPropertyBag_WriteStr(IPropertyBag *ppb, LPCWSTR
pszPropName, LP
 
 /**************************************************************************
  *  SHPropertyBag_WriteGUID (SHLWAPI.506)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/wri…
  */
 HRESULT WINAPI SHPropertyBag_WriteGUID(IPropertyBag *ppb, LPCWSTR pszPropName, const GUID
*pguid)
 {
@@ -5919,6 +5960,8 @@ HRESULT WINAPI SHPropertyBag_WriteGUID(IPropertyBag *ppb, LPCWSTR
pszPropName, c
 
 /**************************************************************************
  *  SHPropertyBag_WriteStream (SHLWAPI.532)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/wri…
  */
 HRESULT WINAPI SHPropertyBag_WriteStream(IPropertyBag *ppb, LPCWSTR pszPropName, IStream
*pStream)
 {
@@ -5939,6 +5982,8 @@ HRESULT WINAPI SHPropertyBag_WriteStream(IPropertyBag *ppb, LPCWSTR
pszPropName,
 
 /**************************************************************************
  *  SHPropertyBag_WritePOINTL (SHLWAPI.522)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/wri…
  */
 HRESULT WINAPI SHPropertyBag_WritePOINTL(IPropertyBag *ppb, LPCWSTR pszPropName, const
POINTL *pptl)
 {
@@ -5984,6 +6029,8 @@ HRESULT WINAPI SHPropertyBag_WritePOINTL(IPropertyBag *ppb, LPCWSTR
pszPropName,
 
 /**************************************************************************
  *  SHPropertyBag_WritePOINTS (SHLWAPI.526)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/wri…
  */
 HRESULT WINAPI SHPropertyBag_WritePOINTS(IPropertyBag *ppb, LPCWSTR pszPropName, const
POINTS *ppts)
 {
@@ -6004,6 +6051,8 @@ HRESULT WINAPI SHPropertyBag_WritePOINTS(IPropertyBag *ppb, LPCWSTR
pszPropName,
 
 /**************************************************************************
  *  SHPropertyBag_WriteRECTL (SHLWAPI.524)
+ *
+ * @see
https://www.geoffchappell.com/studies/windows/shell/shlwapi/api/propbag/wri…
  */
 HRESULT WINAPI SHPropertyBag_WriteRECTL(IPropertyBag *ppb, LPCWSTR pszPropName, const
RECTL *prcl)
 {