[sword-devel] Sword Docs

[Greg Hellings]

Troy,

I updated the documentation to now include a vastly larger amount of
information, even down to the individual structs, etc.  It now has all
of the gory details, from the looks of it to me.  Is that closer to
what was missing?  Does anyone else see missing data or areas for
improvement (If you have experience with Doxygen and think you'd
rather set certain values differently than I have to make things more
readable, by all means, please let me know.  This is my first use of
Doxygen).

--Greg

On Sat, Aug 30, 2008 at 8:13 PM, Greg Hellings <greg.hellings at gmail.com> wrote:
> On Sat, Aug 30, 2008 at 5:18 PM, Troy A. Griffitts <scribe at crosswire.org> wrote:
>> The reason I ask is because on VerseKey the builtin stuff should now be
>> gone and the new VerseMgr is now showing up.  Also noticed that the
>> lowest level drivers are not showing up (eg., RawGenBook, zText, etc.).
>>  Maybe there is a config file somewhere that lists which classes should
>> be documented, or maybe how deep to go in the directory hierarchy?  Not
>> sure.
>>
>>        -Troy.
>
> I'll look at the configs -- there is a limit to how deep the recursion
> will go, but I believe that I set it to 30 or so levels deep.
> However, there were some options to turn on and off producing
> documentation for classes if they contain no Doxygen documentation,
> etc.  Also, depending on the class inheritence hierarchy, some classes
> will or will not generate documentation if they are a child class that
> has no further documentation, etc.  I'll look for those settings and
> see what I come up with.
>
> --Greg
>
>>
>>
>>
>>
>> Greg Hellings wrote:
>>> Troy,
>>>
>>> On Sat, Aug 30, 2008 at 5:36 AM, Troy A. Griffitts <scribe at crosswire.org> wrote:
>>>> Thanks Greg.  Looks nice.  I don't think that is current SVN though.
>>>
>>> svn co http://www.crosswire.org/svn/sword/trunk
>>>
>>> That's the current SVN trunk, revision 2192, which I pulled fresh for
>>> that task.  Are you working off of a branch at current that would be
>>> more up-to-date?
>>>
>>> --Greg
>>>
>>>> Greg Hellings wrote:
>>>>> Hi,
>>>>>
>>>>> I've been rather frantic in scrambling around trying to locate source
>>>>> files and class hierarchies and inheritance information in the
>>>>> library.  I remember someone used to have a nice set of documentation
>>>>> for the system up on the Crosswire server that had been generated with
>>>>> Doxygen, but I believe it was out of date at the time, which was going
>>>>> on a few years back already (1.5.8 or 1.5.7 -- something like that).
>>>>> As such, I've dropped out some Doxygen HTML docs from the current
>>>>> source tree in SVN and placed them in
>>>>> http://www.crosswire.org/~ghellings/svnclassdocs/.  If there's
>>>>> something nagging at you about the format of them, etc, I can try to
>>>>> fiddle with the Doxygen configuration file to see if it can be
>>>>> modified.  I elected to have it output the graphs, etc, using UML-like
>>>>> syntax, seeing as it will probably be the best understood format for
>>>>> such diagrams.
>>>>>
>>>>> One useful side-effect of having the documentation is that it can be
>>>>> an easy reference for which methods and members are NOT documented
>>>>> (and probably should be).  Essentially, any method or member which is
>>>>> not a link in the class page, is an undocumented (or possibly has
>>>>> non-doxygen-formatted documentation) portion of the engine.
>>>>> Documentation is often a place where newcomers to a project can fit in
>>>>> well while they learn the ins and outs of the code.
>>>>>
>>>>> --Greg
>>>>>
>>>>> _______________________________________________
>>>>> sword-devel mailing list: sword-devel at crosswire.org
>>>>> http://www.crosswire.org/mailman/listinfo/sword-devel
>>>>> Instructions to unsubscribe/change your settings at above page
>>>>
>>>> _______________________________________________
>>>> sword-devel mailing list: sword-devel at crosswire.org
>>>> http://www.crosswire.org/mailman/listinfo/sword-devel
>>>> Instructions to unsubscribe/change your settings at above page
>>>>
>>>
>>> _______________________________________________
>>> sword-devel mailing list: sword-devel at crosswire.org
>>> http://www.crosswire.org/mailman/listinfo/sword-devel
>>> Instructions to unsubscribe/change your settings at above page
>>
>>
>> _______________________________________________
>> sword-devel mailing list: sword-devel at crosswire.org
>> http://www.crosswire.org/mailman/listinfo/sword-devel
>> Instructions to unsubscribe/change your settings at above page
>>
>