Feature #7700

Generate documentation for AI/GS libraries

Added by frosch over 4 years ago. Updated over 4 years ago.

Status:FeedbackStart date:2015-06-17
Priority:NormalDue date:
Assignee:-% Done:

100%

Category:Compile Farm
Target version:-

Description

The compile farm should have a target for generating doxygen documentation for AI and GS libraries, and publish them on bundles.

See https://www.tt-forums.net/viewtopic.php?f=65&t=73204

add_doxygen.diff Magnifier (1.57 KB) planetmaker, 2015-06-18 14:50

History

#1 Updated by frosch over 4 years ago

  • Category set to Compile Farm

#2 Updated by planetmaker over 4 years ago

Doxygen is installed on CF now as is the squirrel2doxygen script, available under ~/bin/repos/squirrel2doxygen/doxygen_squirrel_filter.py

Currently there is only two script project which have a build job: busy-bee-gs and bee-awards. But this needs some more automatization, especially hiding the absolute path of the filter.

The one way I see that being possible is to create a default script build target (defined via a .devzone entry similar to NewGRFs define 'nml') and include the explicit script path in this default target (thus projects don't need to worry about that, they just define that they are a default script project). Starting diff attached

#3 Updated by planetmaker over 4 years ago

  • % Done changed from 0 to 100
  • Status changed from New to Feedback

A change to the DevZone CF was submitted in 260:34de90332883 so that scripts are now treated specially and allow for doxygen generation, similar to the patch attached here.

Also available in: Atom PDF