Ticket #203 (new enhancement)

Opened 1 year ago

Library info into class docs

Reported by: dirk Assigned to: dirk
Priority: minor Milestone: 2.0 Release
Component: Documentation Version: 2.0
Keywords: Cc:
Completion:

Description

It looks like 2 will be split into significantly more libs than 1. That will make it harder for people to figure out which libs they need to link for everything to be found. It would be useful if that info was available in the documentation, as part of the doxygen pages. Because it might change fairly often during dev, and because it's a pain to keep up to date it would be useful to have an automatic way to get that information into the documentation.

I'm thinking a preprocessor that runs through the code when enable_docs is on and updates keywords in the files. Thanks to scons looking at file contents it shouldn't hurt to change the file, or it could check for diffs and ignore the update when it's not changing anything.