I had posted an example some time ago but stupidly forgot to sanitise
it of client references and product names and it subsequently got
Googled to cause some embarrassment (note this does NOT include full
source code or anything other than class design).
Following a discussion on the forum
http://forums.realsoftware.com/viewtopic.php?p=67256 I have a better
example online.
Within its limits, which do NOT include the <sourceline> elements
inside the methods, it is very robust. The main consequence of not
including the source is that collaboration diagrams are only accurate
as far as types passed in as parameters.
I have put a sanitised sample online at http://www.oofile.com.au/
rb2doxysample/index.html with the 19MB archive downloadable at http://
www.oofile.com.au/downloads.html#DownloadREALbasic
As you can see from browsing that example, the current RB framework
classes are incomplete - I added class definitions for the ones I
needed directly but need to write a scraper for the HTML files in the
Language Reference to regenerate these. Help or funding to cover that
would be appreciated
...
As you can see from this example, it already goes a long way to
documenting a fairly complex RB program.
You can add class or method documentation in an external file and so
the description will be incorporated in the generated docs, such as
http://www.oofile.com.au/rb2doxysample/class_inspector_window.html
which comes from the minimal markup shown below, on a class
description in a separate .java file
Code:
/**
\class InspectorWindow
The inspector window is a resonably lightweight implementation even ...
\par Resizing:
(courtesy email from Gary 10 May 2004)
You must handle all resizing yourself. The inspector starts off at
a ...
*/
One of the things I really like about Doxygen is not just its
flexibility in separating code and documentation, if you want to, but
that it makes it easy to write hyperlinked related pages and to
include little inline diagrams specified in the DOT language http://
www.graphviz.org/, as you can see in the Window Updates page http://
www.oofile.com.au/rb2doxysample/pagewindowupdates.html
Andy Dent BSc MACS http://www.oofile.com.au/
OOFILE - Database, Reports, Graphs, GUI for c++ on multiple platforms
REALbasic, C++, Python, Mac and Windows development and porting
_______________________________________________
Unsubscribe or switch delivery mode:
<http://www.realsoftware.com/support/listmanager/>
Search the archives:
<http://support.realsoftware.com/listarchives/lists.html>
