From 3b223f7e1b2d8ff79f2ea1bdd9027bf47f156d02 Mon Sep 17 00:00:00 2001 From: Martin Fuchs Date: Sat, 1 Nov 2003 23:17:59 +0000 Subject: [PATCH] extend doxygen documentation svn path=/trunk/; revision=6494 --- reactos/subsys/system/explorer/Doxyfile | 2 +- reactos/subsys/system/explorer/Doxyfile-all | 2 +- reactos/subsys/system/explorer/Makefile | 5 ++- .../subsys/system/explorer/desktop/desktop.h | 8 ++--- .../system/explorer/dialogs/searchprogram.h | 2 ++ .../subsys/system/explorer/doxy-footer.html | 16 +++++++++ reactos/subsys/system/explorer/globals.h | 1 + .../subsys/system/explorer/make_explorer.dsp | 2 +- .../subsys/system/explorer/shell/filechild.h | 2 ++ .../subsys/system/explorer/shell/mainframe.h | 1 + reactos/subsys/system/explorer/shell/pane.h | 1 + .../system/explorer/shell/shellbrowser.h | 8 ++--- .../subsys/system/explorer/shell/shellfs.h | 1 + .../system/explorer/taskbar/traynotify.h | 2 ++ .../subsys/system/explorer/updatefooter.bat | 0 .../system/explorer/utility/dragdropimpl.h | 21 ++++++------ .../explorer/utility/shellbrowserimpl.h | 34 +++++++++---------- .../system/explorer/utility/shellclasses.h | 25 ++++++++++---- .../subsys/system/explorer/utility/window.h | 5 +-- 19 files changed, 90 insertions(+), 48 deletions(-) create mode 100644 reactos/subsys/system/explorer/doxy-footer.html create mode 100755 reactos/subsys/system/explorer/updatefooter.bat diff --git a/reactos/subsys/system/explorer/Doxyfile b/reactos/subsys/system/explorer/Doxyfile index 783db263317..62f75602e7c 100644 --- a/reactos/subsys/system/explorer/Doxyfile +++ b/reactos/subsys/system/explorer/Doxyfile @@ -103,7 +103,7 @@ GENERATE_HTML = YES HTML_OUTPUT = html HTML_FILE_EXTENSION = .html HTML_HEADER = -HTML_FOOTER = +HTML_FOOTER = doxy-footer.html HTML_STYLESHEET = HTML_ALIGN_MEMBERS = YES GENERATE_HTMLHELP = YES diff --git a/reactos/subsys/system/explorer/Doxyfile-all b/reactos/subsys/system/explorer/Doxyfile-all index 9df579b4a19..bd136bf882b 100644 --- a/reactos/subsys/system/explorer/Doxyfile-all +++ b/reactos/subsys/system/explorer/Doxyfile-all @@ -103,7 +103,7 @@ GENERATE_HTML = YES HTML_OUTPUT = html HTML_FILE_EXTENSION = .html HTML_HEADER = -HTML_FOOTER = +HTML_FOOTER = doxy-footer.html HTML_STYLESHEET = HTML_ALIGN_MEMBERS = YES GENERATE_HTMLHELP = YES diff --git a/reactos/subsys/system/explorer/Makefile b/reactos/subsys/system/explorer/Makefile index 00625f492ce..928e8ace065 100644 --- a/reactos/subsys/system/explorer/Makefile +++ b/reactos/subsys/system/explorer/Makefile @@ -66,12 +66,15 @@ LIBS = gdi32 comctl32 ole32 uuid all: buildno.h $(TARGET) -docu: +docu: doxy-footer.html doxygen Doxyfile full-docu: doxygen Doxyfile-all +doxy-footer.html: doxy-footer.htmt + updatefooter + buildno.h: ../../../include/reactos/buildno.h updatebuildno diff --git a/reactos/subsys/system/explorer/desktop/desktop.h b/reactos/subsys/system/explorer/desktop/desktop.h index cb819a8e64d..aa5ded5c74d 100644 --- a/reactos/subsys/system/explorer/desktop/desktop.h +++ b/reactos/subsys/system/explorer/desktop/desktop.h @@ -46,25 +46,25 @@ struct DesktopWindow : public Window, public IShellBrowserImpl static HWND Create(); - STDMETHOD(GetWindow)(HWND* lphwnd) + virtual HRESULT STDMETHODCALLTYPE GetWindow(HWND* lphwnd) { *lphwnd = _hwnd; return S_OK; } - STDMETHOD(QueryActiveShellView)(IShellView** ppshv) + virtual HRESULT STDMETHODCALLTYPE QueryActiveShellView(IShellView** ppshv) { _pShellView->AddRef(); *ppshv = _pShellView; return S_OK; } - STDMETHOD(GetControlWindow)(UINT id, HWND* lphwnd) + virtual HRESULT STDMETHODCALLTYPE GetControlWindow(UINT id, HWND* lphwnd) { return E_NOTIMPL; } - STDMETHOD(SendControlMsg)(UINT id, UINT uMsg, WPARAM wParam, LPARAM lParam, LRESULT* pret) + virtual HRESULT STDMETHODCALLTYPE SendControlMsg(UINT id, UINT uMsg, WPARAM wParam, LPARAM lParam, LRESULT* pret) { return E_NOTIMPL; } diff --git a/reactos/subsys/system/explorer/dialogs/searchprogram.h b/reactos/subsys/system/explorer/dialogs/searchprogram.h index 40ea5a8aec2..f956a783112 100644 --- a/reactos/subsys/system/explorer/dialogs/searchprogram.h +++ b/reactos/subsys/system/explorer/dialogs/searchprogram.h @@ -33,6 +33,7 @@ typedef void (*COLLECT_CALLBACK)(ShellFolder& folder, ShellEntry* shell_entry, void* param); typedef stack ShellDirectoryStack; + /// Thread for collecting start menu entries struct CollectProgramsThread : public Thread { CollectProgramsThread(COLLECT_CALLBACK callback, HWND hwnd, void* para) @@ -74,6 +75,7 @@ struct FPDEntry typedef list FPDCache; + /// Dialog to work with the complete list of start menu entries struct FindProgramDlg : public ResizeController { typedef ResizeController super; diff --git a/reactos/subsys/system/explorer/doxy-footer.html b/reactos/subsys/system/explorer/doxy-footer.html new file mode 100644 index 00000000000..e2f92d33c55 --- /dev/null +++ b/reactos/subsys/system/explorer/doxy-footer.html @@ -0,0 +1,16 @@ +
+ + + + + +
+ROS Explore Source Code Documentation +
generated on 1.11.2003 by +doxygen +
+ 		+

ROS Explorer Homepage +

+ + diff --git a/reactos/subsys/system/explorer/globals.h b/reactos/subsys/system/explorer/globals.h index 0f6163ffc88..fe361f6ad62 100644 --- a/reactos/subsys/system/explorer/globals.h +++ b/reactos/subsys/system/explorer/globals.h @@ -47,6 +47,7 @@ extern struct ExplorerGlobals #define LOG(x) if (g_Globals._log) _ftprintf(g_Globals._log, TEXT("%s\n"), (LPCTSTR)(x)); + /// conventient loading of string resources struct ResString : public String { ResString(UINT nid); diff --git a/reactos/subsys/system/explorer/make_explorer.dsp b/reactos/subsys/system/explorer/make_explorer.dsp index 76462baa6c2..a6fa5708bbe 100644 --- a/reactos/subsys/system/explorer/make_explorer.dsp +++ b/reactos/subsys/system/explorer/make_explorer.dsp @@ -128,7 +128,7 @@ CFG=make_explorer - Win32 doxy docu # PROP Use_Debug_Libraries 1 # PROP Output_Dir "Debug" # PROP Intermediate_Dir "Debug" -# PROP Cmd_Line "msdevfilt -java doxygen" +# PROP Cmd_Line "msdevfilt -java make docu" # PROP Rebuild_Opt "Doxyfile-all" # PROP Target_File "doxy-doc\html\index.html" # PROP Bsc_Name "" diff --git a/reactos/subsys/system/explorer/shell/filechild.h b/reactos/subsys/system/explorer/shell/filechild.h index ebfc97ed659..043359473fb 100644 --- a/reactos/subsys/system/explorer/shell/filechild.h +++ b/reactos/subsys/system/explorer/shell/filechild.h @@ -26,6 +26,7 @@ // + /// information structure for creation of FileChildWindow struct FileChildWndInfo { FileChildWndInfo(LPCTSTR path); @@ -46,6 +47,7 @@ struct ShellChildWndInfo : public FileChildWndInfo }; + /// MDI child window displaying file lists struct FileChildWindow : public ChildWindow { typedef ChildWindow super; diff --git a/reactos/subsys/system/explorer/shell/mainframe.h b/reactos/subsys/system/explorer/shell/mainframe.h index 177cb11c83d..3d7cb7917d9 100644 --- a/reactos/subsys/system/explorer/shell/mainframe.h +++ b/reactos/subsys/system/explorer/shell/mainframe.h @@ -30,6 +30,7 @@ enum OPEN_WINDOW_MODE {OWM_EXPLORE=1, OWM_DETAILS=2, OWM_PIDL=4}; + /// Explorer frame window struct MainFrame : public PreTranslateWindow { typedef PreTranslateWindow super; diff --git a/reactos/subsys/system/explorer/shell/pane.h b/reactos/subsys/system/explorer/shell/pane.h index 6735359d091..e7a14141b42 100644 --- a/reactos/subsys/system/explorer/shell/pane.h +++ b/reactos/subsys/system/explorer/shell/pane.h @@ -59,6 +59,7 @@ struct OutputWorker }; + /// child window pane for displaying file lists struct Pane : public SubclassedWindow { typedef SubclassedWindow super; diff --git a/reactos/subsys/system/explorer/shell/shellbrowser.h b/reactos/subsys/system/explorer/shell/shellbrowser.h index 1bb6354a12c..1472f92f7c8 100644 --- a/reactos/subsys/system/explorer/shell/shellbrowser.h +++ b/reactos/subsys/system/explorer/shell/shellbrowser.h @@ -51,21 +51,21 @@ struct ShellBrowserChild : public ChildWindow, public IShellBrowserImpl } //IOleWindow - STDMETHOD(GetWindow)(HWND* lphwnd) + virtual HRESULT STDMETHODCALLTYPE GetWindow(HWND* lphwnd) { *lphwnd = _hwnd; return S_OK; } //IShellBrowser - STDMETHOD(QueryActiveShellView)(IShellView** ppshv) + virtual HRESULT STDMETHODCALLTYPE QueryActiveShellView(IShellView** ppshv) { _pShellView->AddRef(); *ppshv = _pShellView; return S_OK; } - STDMETHOD(GetControlWindow)(UINT id, HWND* lphwnd) + virtual HRESULT STDMETHODCALLTYPE GetControlWindow(UINT id, HWND* lphwnd) { if (!lphwnd) return E_POINTER; @@ -85,7 +85,7 @@ struct ShellBrowserChild : public ChildWindow, public IShellBrowserImpl return E_NOTIMPL; } - STDMETHOD(SendControlMsg)(UINT id, UINT uMsg, WPARAM wParam, LPARAM lParam, LRESULT* pret) + virtual HRESULT STDMETHODCALLTYPE SendControlMsg(UINT id, UINT uMsg, WPARAM wParam, LPARAM lParam, LRESULT* pret) { if (!pret) return E_POINTER; diff --git a/reactos/subsys/system/explorer/shell/shellfs.h b/reactos/subsys/system/explorer/shell/shellfs.h index 0f71b1218c1..9fbfe838b7c 100644 --- a/reactos/subsys/system/explorer/shell/shellfs.h +++ b/reactos/subsys/system/explorer/shell/shellfs.h @@ -26,6 +26,7 @@ // + /// shell file/directory entry struct ShellEntry : public Entry { ShellEntry(Entry* parent, LPITEMIDLIST shell_path) : Entry(parent), _pidl(shell_path) {} diff --git a/reactos/subsys/system/explorer/taskbar/traynotify.h b/reactos/subsys/system/explorer/taskbar/traynotify.h index a78ae4fb616..ae96c3e7f28 100644 --- a/reactos/subsys/system/explorer/taskbar/traynotify.h +++ b/reactos/subsys/system/explorer/taskbar/traynotify.h @@ -35,6 +35,7 @@ #define CLOCKWINDOW_WIDTH 32 + /// NotifyIconIndex is used for maintaining the order of notification icons. struct NotifyIconIndex { NotifyIconIndex(NOTIFYICONDATA* pnid); @@ -50,6 +51,7 @@ protected: NotifyIconIndex(); }; + /// structure for maintaining informations of one notification icons struct NotifyInfo : public NotifyIconIndex { NotifyInfo(); diff --git a/reactos/subsys/system/explorer/updatefooter.bat b/reactos/subsys/system/explorer/updatefooter.bat new file mode 100755 index 00000000000..e69de29bb2d diff --git a/reactos/subsys/system/explorer/utility/dragdropimpl.h b/reactos/subsys/system/explorer/utility/dragdropimpl.h index fdc87c937ba..f4d436ab31f 100644 --- a/reactos/subsys/system/explorer/utility/dragdropimpl.h +++ b/reactos/subsys/system/explorer/utility/dragdropimpl.h @@ -22,6 +22,7 @@ struct DataStorage { typedef vector StorageArray; + /// implementation of IEnumFORMATETC interface class EnumFormatEtcImpl : public IEnumFORMATETC { private: @@ -35,18 +36,18 @@ class EnumFormatEtcImpl : public IEnumFORMATETC virtual ~EnumFormatEtcImpl() {} //IUnknown members - STDMETHOD(QueryInterface)(REFIID, void**); - STDMETHOD_(ULONG, AddRef)(void); - STDMETHOD_(ULONG, Release)(void); + virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID, void**); + virtual ULONG STDMETHODCALLTYPE AddRef(void); + virtual ULONG STDMETHODCALLTYPE Release(void); //IEnumFORMATETC members - STDMETHOD(Next)(ULONG, LPFORMATETC, ULONG*); - STDMETHOD(Skip)(ULONG); - STDMETHOD(Reset)(void); - STDMETHOD(Clone)(IEnumFORMATETC**); + virtual HRESULT STDMETHODCALLTYPE Next(ULONG, LPFORMATETC, ULONG*); + virtual HRESULT STDMETHODCALLTYPE Skip(ULONG); + virtual HRESULT STDMETHODCALLTYPE Reset(void); + virtual HRESULT STDMETHODCALLTYPE Clone(IEnumFORMATETC**); }; -/////////////////////////////////////////////////////////////////////////////////////////////// + /// implementation of IDropSource interface class IDropSourceImpl : public IDropSource { long m_cRefCount; @@ -71,7 +72,7 @@ public: /* [in] */ DWORD dwEffect); }; -/////////////////////////////////////////////////////////////////////////////////////////////// + /// implementation of IDataObject interface class IDataObjectImpl : public IDataObject//,public IAsyncOperation { IDropSourceImpl* m_pDropSource; @@ -163,7 +164,7 @@ public: //}*/ }; -/////////////////////////////////////////////////////////////////////////////////////////////// + /// implementation of IDropTarget interface class IDropTargetImpl : public IDropTarget { DWORD m_cRefCount; diff --git a/reactos/subsys/system/explorer/utility/shellbrowserimpl.h b/reactos/subsys/system/explorer/utility/shellbrowserimpl.h index 8215dd35188..8626264fad3 100644 --- a/reactos/subsys/system/explorer/utility/shellbrowserimpl.h +++ b/reactos/subsys/system/explorer/utility/shellbrowserimpl.h @@ -35,38 +35,38 @@ struct IShellBrowserImpl : public IShellBrowser, public ICommDlgBrowser { } - STDMETHOD(QueryInterface)(REFIID iid, void** ppvObject); + virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, void** ppvObject); - STDMETHOD_(ULONG, AddRef)() {return ++_dwRef;} - STDMETHOD_(ULONG, Release)() {return --_dwRef;} //not heap based + virtual ULONG STDMETHODCALLTYPE AddRef() {return ++_dwRef;} + virtual ULONG STDMETHODCALLTYPE Release() {return --_dwRef;} //not heap based // *** IOleWindow methods *** - STDMETHOD(ContextSensitiveHelp)(BOOL fEnterMode) {return E_NOTIMPL;} + virtual HRESULT STDMETHODCALLTYPE ContextSensitiveHelp(BOOL fEnterMode) {return E_NOTIMPL;} // *** ICommDlgBrowser methods *** - STDMETHOD(OnDefaultCommand)(IShellView* ppshv); + virtual HRESULT STDMETHODCALLTYPE OnDefaultCommand(IShellView* ppshv); - STDMETHOD(OnStateChange)(IShellView* ppshv, ULONG uChange) + virtual HRESULT STDMETHODCALLTYPE OnStateChange(IShellView* ppshv, ULONG uChange) { //handle selection, rename, focus if needed return E_NOTIMPL; } - STDMETHOD(IncludeObject)(IShellView* ppshv, LPCITEMIDLIST pidl) + virtual HRESULT STDMETHODCALLTYPE IncludeObject(IShellView* ppshv, LPCITEMIDLIST pidl) { //filter files if needed return S_OK; } // *** IShellBrowser methods *** (same as IOleInPlaceFrame) - STDMETHOD(InsertMenusSB)(HMENU hmenuShared, LPOLEMENUGROUPWIDTHS lpMenuWidths) {return E_NOTIMPL;} - STDMETHOD(SetMenuSB)(HMENU hmenuShared, HOLEMENU holemenuReserved, HWND hwndActiveObject) {return E_NOTIMPL;} - STDMETHOD(RemoveMenusSB)(HMENU hmenuShared) {return E_NOTIMPL;} - STDMETHOD(SetStatusTextSB)(LPCOLESTR lpszStatusText) {return E_NOTIMPL;} - STDMETHOD(EnableModelessSB)(BOOL fEnable) {return E_NOTIMPL;} - STDMETHOD(BrowseObject)(LPCITEMIDLIST pidl, UINT wFlags) {return E_NOTIMPL;} - STDMETHOD(GetViewStateStream)(DWORD grfMode, LPSTREAM* ppStrm) {return E_NOTIMPL;} - STDMETHOD(OnViewWindowActive)(IShellView* ppshv) {return E_NOTIMPL;} - STDMETHOD(SetToolbarItems)(LPTBBUTTON lpButtons, UINT nButtons, UINT uFlags) {return E_NOTIMPL;} - STDMETHOD(TranslateAcceleratorSB)(LPMSG lpmsg, WORD wID) {return S_OK;} + virtual HRESULT STDMETHODCALLTYPE InsertMenusSB(HMENU hmenuShared, LPOLEMENUGROUPWIDTHS lpMenuWidths) {return E_NOTIMPL;} + virtual HRESULT STDMETHODCALLTYPE SetMenuSB(HMENU hmenuShared, HOLEMENU holemenuReserved, HWND hwndActiveObject) {return E_NOTIMPL;} + virtual HRESULT STDMETHODCALLTYPE RemoveMenusSB(HMENU hmenuShared) {return E_NOTIMPL;} + virtual HRESULT STDMETHODCALLTYPE SetStatusTextSB(LPCOLESTR lpszStatusText) {return E_NOTIMPL;} + virtual HRESULT STDMETHODCALLTYPE EnableModelessSB(BOOL fEnable) {return E_NOTIMPL;} + virtual HRESULT STDMETHODCALLTYPE BrowseObject(LPCITEMIDLIST pidl, UINT wFlags) {return E_NOTIMPL;} + virtual HRESULT STDMETHODCALLTYPE GetViewStateStream(DWORD grfMode, LPSTREAM* ppStrm) {return E_NOTIMPL;} + virtual HRESULT STDMETHODCALLTYPE OnViewWindowActive(IShellView* ppshv) {return E_NOTIMPL;} + virtual HRESULT STDMETHODCALLTYPE SetToolbarItems(LPTBBUTTON lpButtons, UINT nButtons, UINT uFlags) {return E_NOTIMPL;} + virtual HRESULT STDMETHODCALLTYPE TranslateAcceleratorSB(LPMSG lpmsg, WORD wID) {return S_OK;} protected: DWORD _dwRef; diff --git a/reactos/subsys/system/explorer/utility/shellclasses.h b/reactos/subsys/system/explorer/utility/shellclasses.h index b7be6fb3760..1a3f7ccf13b 100644 --- a/reactos/subsys/system/explorer/utility/shellclasses.h +++ b/reactos/subsys/system/explorer/utility/shellclasses.h @@ -54,6 +54,7 @@ using namespace _com_util; #else + /// COM Exception class as replacement for _com_error struct COMException { COMException(HRESULT hr) @@ -100,7 +101,7 @@ inline void CheckError(HRESULT hr) #endif - // COM Initialisation + /// COM Initialisation struct ComInit { @@ -123,7 +124,7 @@ struct ComInit }; - // OLE initialisation for drag drop support + /// OLE initialisation for drag drop support struct OleInit { @@ -139,12 +140,12 @@ struct OleInit }; - // Exception Handler for COM exceptions + /// Exception Handler for COM exceptions extern void HandleException(COMException& e, HWND hwnd); - // We use a common IMalloc object for all shell memory allocations. + /// We use a common IMalloc object for all shell memory allocations. struct CommonShellMalloc { @@ -350,10 +351,11 @@ protected: - // caching of desktop ShellFolder object - struct ShellFolder; + + /// caching of desktop ShellFolder object + struct CommonDesktop { CommonDesktop() @@ -365,7 +367,7 @@ struct CommonDesktop void init(); - operator struct ShellFolder&() + operator ShellFolder&() { return *_desktop; } @@ -377,6 +379,7 @@ protected: #ifndef _NO_COMUTIL // _com_ptr available? + /// IShellFolder smart pointer struct ShellFolder : public IShellFolderPtr // IShellFolderPtr uses intrinsic extensions of the VC++ compiler. { typedef IShellFolderPtr super; @@ -398,6 +401,7 @@ struct ShellFolder : public IShellFolderPtr // IShellFolderPtr uses intrinsic ex #define IShellLinkPtr IShellLinkAPtr #endif + /// IShellLink smart pointer struct ShellLinkPtr : public IShellLinkPtr { typedef IShellLinkPtr super; @@ -413,6 +417,7 @@ struct ShellLinkPtr : public IShellLinkPtr #else // _com_ptr not available -> use SIfacePtr + /// IShellFolder smart pointer struct ShellFolder : public SIfacePtr { typedef SIfacePtr super; @@ -426,6 +431,7 @@ struct ShellFolder : public SIfacePtr String get_name(LPCITEMIDLIST pidl, SHGDNF flags=SHGDN_NORMAL) const; }; + /// IShellLink smart pointer struct ShellLinkPtr : public SIfacePtr { typedef SIfacePtr super; @@ -732,6 +738,7 @@ public: }; + /// Browse dialog operating on shell namespace struct FolderBrowser : public FileSysShellPath { FolderBrowser(HWND owner, UINT flags, LPCTSTR title, LPCITEMIDLIST root=0) @@ -765,6 +772,7 @@ private: }; + /// Retrieval of special shell folder paths struct SpecialFolderPath : public ShellPath { SpecialFolderPath(int folder, HWND hwnd) @@ -774,6 +782,7 @@ struct SpecialFolderPath : public ShellPath } }; + /// Shell folder path of the desktop struct DesktopFolderPath : public SpecialFolderPath { DesktopFolderPath() @@ -782,6 +791,7 @@ struct DesktopFolderPath : public SpecialFolderPath } }; + /// Retrieval of special shell folder struct SpecialFolder : public ShellFolder { SpecialFolder(int folder, HWND hwnd) @@ -790,6 +800,7 @@ struct SpecialFolder : public ShellFolder } }; + /// Shell folder of the desktop struct DesktopFolder : public ShellFolder { }; diff --git a/reactos/subsys/system/explorer/utility/window.h b/reactos/subsys/system/explorer/utility/window.h index e53d00bdf75..7f17fea23d4 100644 --- a/reactos/subsys/system/explorer/utility/window.h +++ b/reactos/subsys/system/explorer/utility/window.h @@ -511,10 +511,9 @@ template struct CtlColorParent : public BASE */ - // owner draw message routing for ColorButton and PictureButton - #define PM_DISPATCH_DRAWITEM (WM_APP+0x09) + /// draw message routing for ColorButton and PictureButton template struct OwnerDrawParent : public BASE { typedef BASE super; @@ -606,6 +605,7 @@ protected: }; + /// encapsulation of tool tip controls struct ToolTip : public WindowHandle { typedef WindowHandle super; @@ -664,6 +664,7 @@ inline int ListView_GetFocusedItem(HWND list_ctrl) } + /// sorting of list controls struct ListSort : public WindowHandle { ListSort(HWND hwndListview, PFNLVCOMPARE compare_fct);