[sword-devel] Documentation update

[Greg Hellings]

List,
I've updated the sword-svn documentation kept in
http://www.crosswire.org/~ghellings/svnclassdocs/ to revision 2205 of the
SVN tree.

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.

The remaining warnings are as follows:

/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:
  parameter 'multiMod'
/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:
  parameter 'autoload'
  parameter 'filterMgr'
  parameter 'multiMod'
  parameter 'augmentHome'

****Greg's note: these might represent different naming schemes between the
header and the implementation file - but I'm not certain about that****
/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
/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
/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
/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:
  parameter 'buf'
  parameter 'maxlen'
/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
/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
/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:
  parameter 'maxlen'

/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:
  parameter 'pos'

/space/home/ghellings/sword-svn/src/modules/swmodule.cpp:1248: Warning: no
matching class member found for
  void SWModule::filterBuffer(std::list< SWOptionFilter * > *filters, SWBuf
&buf, SWKey *key)
Possible candidates:
  virtual void SWModule::filterBuffer(OptionFilterList *filters, SWBuf &buf,
SWKey *key)
  virtual void SWModule::filterBuffer(FilterList *filters, SWBuf &buf, SWKey
*key)
/space/home/ghellings/sword-svn/src/modules/swmodule.cpp:1260: Warning: no
matching class member found for
  void SWModule::filterBuffer(std::list< SWFilter * > *filters, SWBuf &buf,
SWKey *key)
Possible candidates:
  virtual void SWModule::filterBuffer(OptionFilterList *filters, SWBuf &buf,
SWKey *key)
  virtual void SWModule::filterBuffer(FilterList *filters, SWBuf &buf, SWKey
*key)
/space/home/ghellings/sword-svn/include/apocrypha.h:212: Warning: documented
function `long VerseKey::atbks' was not declared or defined.
/space/home/ghellings/sword-svn/include/apocrypha.h:217: Warning: documented
function `long VerseKey::atcps' was not declared or defined.

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).

--Greg
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://www.crosswire.org/pipermail/sword-devel/attachments/20080923/fea6e021/attachment.html 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: doxygen.diff
Type: application/octet-stream
Size: 2637 bytes
Desc: not available
Url : http://www.crosswire.org/pipermail/sword-devel/attachments/20080923/fea6e021/attachment.obj