[ros-diffs] [ssawant] 75689: [QCKLNCH] -Documented the required functions and modules. -Minor cleanup.

Author: ssawant
Date: Sun Aug 27 11:42:54 2017
New Revision: 75689

URL: http://svn.reactos.org/svn/reactos?rev=75689&view=rev
Log:
[QCKLNCH]
-Documented the required functions and modules.
-Minor cleanup.

Modified:
    branches/GSoC_2017/shellext/reactos/dll/shellext/qcklnch/CISFBand.cpp
    branches/GSoC_2017/shellext/reactos/dll/shellext/qcklnch/CISFBand.h
    branches/GSoC_2017/shellext/reactos/dll/shellext/qcklnch/CQuickLaunchBand.cpp

Modified: branches/GSoC_2017/shellext/reactos/dll/shellext/qcklnch/CISFBand.cpp
URL:
http://svn.reactos.org/svn/reactos/branches/GSoC_2017/shellext/reactos/dll/…
==============================================================================
--- branches/GSoC_2017/shellext/reactos/dll/shellext/qcklnch/CISFBand.cpp	[iso-8859-1]
(original)
+++ branches/GSoC_2017/shellext/reactos/dll/shellext/qcklnch/CISFBand.cpp	[iso-8859-1] Sun
Aug 27 11:42:54 2017
@@ -15,7 +15,17 @@
 WINE_DEFAULT_DEBUG_CHANNEL(qcklnch);
 
 // ***Extras***
-
+/*++
+* @name _ILIsDesktop
+*
+* Checks whether the given PIDL is of Desktop folder or not.
+*
+* @param pidl
+*        PIDL to be checked.
+*
+* @return True if PIDL is of Desktop, otherwise false.
+*
+*--*/
 BOOL WINAPI _ILIsDesktop(LPCITEMIDLIST pidl)
 {
     return (pidl == NULL || pidl->mkid.cb == 0);
@@ -38,6 +48,17 @@
 }
 
 // Toolbar
+/*++
+* @name CreateSimpleToolbar
+*
+* Creates a toolbar and fills it up with buttons for enumerated objects.
+*
+* @param hWndParent
+*        Handle to the parent window, which receives the appropriate messages from child
toolbar.
+*
+* @return The error code.
+*
+*--*/
 HRESULT CISFBand::CreateSimpleToolbar(HWND hWndParent)
 {
     // Declare and initialize local constants.     

Modified: branches/GSoC_2017/shellext/reactos/dll/shellext/qcklnch/CISFBand.h
URL:
http://svn.reactos.org/svn/reactos/branches/GSoC_2017/shellext/reactos/dll/…
==============================================================================
--- branches/GSoC_2017/shellext/reactos/dll/shellext/qcklnch/CISFBand.h	[iso-8859-1]
(original)
+++ branches/GSoC_2017/shellext/reactos/dll/shellext/qcklnch/CISFBand.h	[iso-8859-1] Sun
Aug 27 11:42:54 2017
@@ -20,7 +20,7 @@
     public IShellFolderBand,
     public IContextMenu
 {
-    // band
+    // Band
     DWORD m_BandID;
     CComPtr<IUnknown> m_Site;
 

Modified: branches/GSoC_2017/shellext/reactos/dll/shellext/qcklnch/CQuickLaunchBand.cpp
URL:
http://svn.reactos.org/svn/reactos/branches/GSoC_2017/shellext/reactos/dll/…
==============================================================================
---
branches/GSoC_2017/shellext/reactos/dll/shellext/qcklnch/CQuickLaunchBand.cpp	[iso-8859-1]
(original)
+++
branches/GSoC_2017/shellext/reactos/dll/shellext/qcklnch/CQuickLaunchBand.cpp	[iso-8859-1]
Sun Aug 27 11:42:54 2017
@@ -39,6 +39,20 @@
     }
 
 // Pidl Browser
+/*++
+* @name PidlBrowse
+*
+* Opens a folder browser dialog,
+* allowing the user to select a folder for enumeration.
+*
+* @param hwnd
+*        A handle to browser dialog window.
+* @param nCSIDL
+*        A CSIDL representing the root from which the browse folder dialog shows the
files and folders.
+*
+* @return The PIDL to selected folder.
+*
+*--*/
     LPITEMIDLIST PidlBrowse(HWND hwnd, int nCSIDL)
     {
         CComHeapPtr<ITEMIDLIST> pidlRoot;
@@ -65,7 +79,14 @@
 
 /*****************************************************************************/
 // ATL Construct
-
+/*++
+* @name FinalConstruct
+*
+* Creates an instance of CISFBand, and initializes its Shell Folder Band for
enumeration.
+*
+* @return The error code.
+*
+*--*/
     HRESULT CQuickLaunchBand::FinalConstruct()
     {
         HRESULT hr = CISFBand_CreateInstance(IID_PPV_ARG(IUnknown, &m_punkISFB));