Xref: lugnet.com lugnet.robotics:3792
Newsgroups: lugnet.robotics
Path: lugnet.com!lugnet
From: lego-robotics@crynwr.com (Markus L. Noga)
Subject: preliminary legOS API documentation
Content-Type: text/plain; charset=iso-8859-1
Reply-To: "Markus L. Noga" <noga@inrialpes.fr>
Content-Transfer-Encoding: 8bit
Sender: mlnoga@i60p4.ira.uka.de
X-Nntp-Gateway: lego-robotics@crynwr.com
Organization: Universitaet Karlsruhe
Message-ID: <36C9C00F.642D920A@inrialpes.fr>
X-Mailer: Mozilla 4.5 [en] (X11; I; Linux 2.2.1 i686)
Mime-Version: 1.0
X-Nntp-Posting-Host: lugnet.com
Date: Tue, 16 Feb 1999 18:59:28 GMT
Original-From: "Markus L. Noga" <noga@inrialpes.fr>
Lines: 26

Hello,

legOS API documentation is in the works. The documentation generator I
intend to use, doxygen, supports HTML, LaTeX and manpage generation from
javadoc and QT style comments. I've made a preliminary version of the
resulting documentation available at this location:
http://www.multimania.com/legos/doc/index.html

There's still lots of work to do, as function documentation should be
moved out of the code and into header files IMO. The documentation could
also use some beautification, i.e., more redundancy, complete sentences,
capitalization etc. Unconsolidated (and thus unreleased) 0.1.7 features
such as a more complete standard library and naked-rock C++ support
could also use some documentation. Volunteers?

Markus.

-- 
Markus L. Noga		noga@inrialpes.fr
Check out legOS!	http://www.multimania.com/legos/
"Wer zitiert, benutzt sein Gedächtnis, nicht seinen Verstand."     
-Nietzsche
"Quand on n'a pas de caractere, il faut bien se donner une
methode."-Camus
--
Did you check the web site first?: http://www.crynwr.com/lego-robotics