<div dir="ltr">List,<div><br></div><div>I've updated the sword-svn documentation kept in <a href="http://www.crosswire.org/~ghellings/svnclassdocs/">http://www.crosswire.org/~ghellings/svnclassdocs/</a> to revision 2205 of the SVN tree.</div>
<div><br></div><div>I have attached a patch which works out several Doxygen errors/warnings, and the following ones remain. I did not feel comfortable filling in the missing documentation that these indicate, so I leave it to someone who is more familiar with those sections of the code. Also, if I may have mislabeled the few portions of the code which are in this patch file, so please take care in looking at that.</div>
<div><br></div><div>The remaining warnings are as follows:</div><div><br></div><div><div>/space/home/ghellings/sword-svn/include/swmgr.h:209: Warning: The following parameters of SWMgr::SWMgr(SWConfig *iconfig=0, SWConfig *isysconfig=0, bool autoload=true, SWFilterMgr *filterMgr=0, bool multiMod=false) are not documented:</div>
<div> parameter 'multiMod'</div><div>/space/home/ghellings/sword-svn/include/swmgr.h:230: Warning: The following parameters of SWMgr::SWMgr(const char *iConfigPath, bool autoload=true, SWFilterMgr *filterMgr=0, bool multiMod=false, bool augmentHome=true) are not documented:</div>
<div> parameter 'autoload'</div><div> parameter 'filterMgr'</div><div> parameter 'multiMod'</div><div> parameter 'augmentHome'</div><div><br></div><div>****Greg's note: these might represent different naming schemes between the header and the implementation file - but I'm not certain about that****</div>
<div><div>/space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:216: Warning: argument 'text' of command @param is not found in the argument list of StringMgr::upperLatin1(char *buf, unsigned int maxlen=0) const</div>
<div>/space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:216: Warning: argument 'max' of command @param is not found in the argument list of StringMgr::upperLatin1(char *buf, unsigned int maxlen=0) const</div><div>
/space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:216: Warning: argument 'The' of command @param is not found in the argument list of StringMgr::upperLatin1(char *buf, unsigned int maxlen=0) const</div><div>/space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:216: Warning: The following parameters of StringMgr::upperLatin1(char *buf, unsigned int maxlen=0) const are not documented:</div>
<div> parameter 'buf'</div><div> parameter 'maxlen'</div><div>/space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:180: Warning: argument 'text' of command @param is not found in the argument list of StringMgr::upperUTF8(char *t, unsigned int maxlen=0) const</div>
<div>/space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:180: Warning: argument 'max' of command @param is not found in the argument list of StringMgr::upperUTF8(char *t, unsigned int maxlen=0) const</div><div>/space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:180: Warning: The following parameters of StringMgr::upperUTF8(char *t, unsigned int maxlen=0) const are not documented:</div>
<div> parameter 'maxlen'</div><div><div><br></div><div>/space/home/ghellings/sword-svn/include/listkey.h:81: Warning: The following parameters of ListKey::SetToElement(int ielement, SW_POSITION pos=TOP) are not documented:</div>
<div> parameter 'pos'</div><div><br></div></div></div></div><div><div>/space/home/ghellings/sword-svn/src/modules/swmodule.cpp:1248: Warning: no matching class member found for</div><div> void SWModule::filterBuffer(std::list< SWOptionFilter * > *filters, SWBuf &buf, SWKey *key)</div>
<div>Possible candidates:</div><div> virtual void SWModule::filterBuffer(OptionFilterList *filters, SWBuf &buf, SWKey *key)</div><div> virtual void SWModule::filterBuffer(FilterList *filters, SWBuf &buf, SWKey *key)</div>
<div>/space/home/ghellings/sword-svn/src/modules/swmodule.cpp:1260: Warning: no matching class member found for</div><div> void SWModule::filterBuffer(std::list< SWFilter * > *filters, SWBuf &buf, SWKey *key)</div>
<div>Possible candidates:</div><div> virtual void SWModule::filterBuffer(OptionFilterList *filters, SWBuf &buf, SWKey *key)</div><div> virtual void SWModule::filterBuffer(FilterList *filters, SWBuf &buf, SWKey *key)</div>
<div>/space/home/ghellings/sword-svn/include/apocrypha.h:212: Warning: documented function `long VerseKey::atbks' was not declared or defined.</div><div>/space/home/ghellings/sword-svn/include/apocrypha.h:217: Warning: documented function `long VerseKey::atcps' was not declared or defined.</div>
<div><br></div><div>Once again, feedback on the documentation configuration is appreciated if you find something missing or too much present, etc, or if you have expertise with Doxygen (because I sure don't).</div><div>
<br></div></div><div>--Greg</div></div>