Opened 8 years ago

Last modified 4 years ago

#4057 new enhancement

doxygen and JSdoc documentation

Reported by: elexis Owned by:
Priority: If Time Permits Milestone: Backlog
Component: Website / Forum Keywords: contributor-experience
Cc: Krinkle Patch:

Description (last modified by Krinkle)

JSdoc (for JS) and doxygen comments (for C++) are used widely in the code and can be used to generate code documentation in HTML. Both tools can be run from the commandline, thus could be installed on a webserver to generate updated docs periodically (cronjob on unix) and present them online.

For JSDoc the docstrap templates seem nice: https://github.com/docstrap/docstrap

As comments should only state things which are not self-evident from the code, the use case of the online documentation will be to have a list of explanation of edge-cases and weird code behavior, while only showing function headers.

Still fairly limited, the benefit will apply to simulation components, like UnitAI, pathfinder, rangemanager, UnitMotion and libraries like the random map scripts (rather than the GUI which doesn't reuse complex code accross many files).

Refs https://wildfiregames.com/forum/index.php?/topic/20728-jsdoc-documentation/#comment-316064

Change History (5)

comment:1 by Krinkle, 4 years ago

Description: modified (diff)

I was browsing around http://docs.wildfiregames.com/ and noticed a Doxygen build published at http://docs.wildfiregames.com/pyrogenesis/.

I'm not sure if this was a one-off or something that used to work more regularly, but it was last updated in April 2019.

What can I do to help get it going again on a regular basis?

Might be related: https://trac.wildfiregames.com/wiki/JenkinsSetupOld

Last edited 4 years ago by Krinkle (previous) (diff)

comment:2 by Krinkle, 4 years ago

Cc: Krinkle added

comment:3 by Krinkle, 4 years ago

Keywords: contributor-experience added

comment:4 by Stan, 4 years ago

Milestone: BacklogWebsite / Forum

comment:5 by Stan, 4 years ago

Milestone: Website / ForumBacklog

In 23844: Add where and how to contribute to README.txt

Reviewed by: wraitii Text by: bb Differential Revision: ​https://code.wildfiregames.com/D2833

Note: See TracTickets for help on using tickets.