Mantis Bug Tracker

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0000032Mana Client[All Projects] Generalpublic2009-11-16 13:572010-07-29 23:41
ReporterBertram 
Assigned Tothorbjorn 
PrioritynormalSeveritymajorReproducibilityN/A
StatusresolvedResolutionfixed 
PlatformOSOS Version
Product Version 
Target VersionFixed in Version 
Summary0000032: Add Doxygen documentation for every sub-projects.
DescriptionThe fact that the Mana Project is willing to be a generic reference is placing the documentation need a step higher.

Every sub-projects (Mana, ManaServ, ManaWeb, ...) should get an online code reference using Doxygen or anything equivalent.

- To lower the updates undertaking, the documentation should be auto-updated, based on a daily basis. (The scripts used for this should be available in the repository for everyone's view.)

- Also, a small documentation page should tell how to build the code documentation itself, perhaps in the wiki.
TagsNo tags attached.
Attached Files

- Relationships

-  Notes
(0000167)
Jaxad0127 (administrator)
2010-01-26 16:08

Lets keep a few up per project: all still supported releases and git. The scripts should probably go in manasource-website.
(0000169)
Bertram (developer)
2010-01-26 17:33

I guess 2 doxyfiles, 2 corresponding scripts:
- Mana and Manaserv for now.
(0000182)
Bertram (developer)
2010-02-01 20:57

Well, the 2 doxyfiles are there. They could be upgraded to the current doxygen version but this very easy. What's missing is nightly build of documentation made using scripts. No admins to do that?
(0000183)
thorbjorn (administrator)
2010-02-01 22:07

Generated manually for now: http://manasource.org/doxygen/ [^] (based on the dated Doxyfiles in the repositories). Will look into setting up a cron job later.
(0000217)
thorbjorn (administrator)
2010-02-23 20:39

Meanwhile, this documentation is automatically updated every hour.

Still on the todo list:

* Add a link to the warnings generated by Doxygen
* Link to this documentation from some page on doc.manasource.org
(0000218)
Jaxad0127 (administrator)
2010-02-23 21:39

I've added a basic link on the start page for it.
(0000473)
Bertram (developer)
2010-05-19 07:04

Can the warnings be added?
(0000692)
thorbjorn (administrator)
2010-07-29 11:10

Links to the warnings have been added at some point.

- Issue History
Date Modified Username Field Change
2009-11-16 13:57 Bertram New Issue
2010-01-26 09:32 Bertram Issue Monitored: Bertram
2010-01-26 16:08 Jaxad0127 Note Added: 0000167
2010-01-26 17:33 Bertram Note Added: 0000169
2010-02-01 20:57 Bertram Note Added: 0000182
2010-02-01 21:18 thorbjorn Status new => assigned
2010-02-01 21:18 thorbjorn Assigned To => thorbjorn
2010-02-01 22:07 thorbjorn Note Added: 0000183
2010-02-23 20:39 thorbjorn Note Added: 0000217
2010-02-23 21:39 Jaxad0127 Note Added: 0000218
2010-05-19 07:04 Bertram Note Added: 0000473
2010-07-29 11:10 thorbjorn Note Added: 0000692
2010-07-29 11:10 thorbjorn Status assigned => resolved
2010-07-29 11:10 thorbjorn Resolution open => fixed
2010-07-29 23:41 Bertram Issue End Monitor: Bertram


Copyright © 2000 - 2010 MantisBT Group
Powered by Mantis Bugtracker