[Doxygen-develop] Documenting the API subset of a project

[Simon G. <sim...@at...>]

Milan wrote:
> I would like to have a new configuration parameter in which I would mention
> the main header file. The generated documentation would contain only
> constructs from the main header file and all the files transitively
> #include-d from it. Other files in the input file set would be left out from
> generated documentation.

It sounds as if you want to generate two sorts of documentation (or you would
never doxygenate and include the 'Other files in the input file set'. One set is
for internal use, and uses the full 'input file set'. The other documentation is
for the library API and refers only to a subset of those files: 'from the main
header file' and the files that includes. Please correct me if I've misunderstood.

At first sight it appears that your requirement will be met by having two
doxyconfig files, one (for the API) being a subset of the other by virtue of
not including  'Other files in the input file set'. The other includes the full
set and generates your unexpurgated internal documentation.

> Let's discuss the feature: should I (or anyone else) implement it? Or can I
> solve it in another way (without having to somehow edit all the files in
> directory).

As long as you keep the doxyconfig file for the public subset of the files
that you want mentioned in the documentation up to date, you should not
need to edit the sources themselves - and we'd be spared another option
in what is already a bewildering array. You can also specify different title
pages, contact information, style sheets etc for the internal and external
documentation easily this way.

Subdirectory organisation (selecting groups of files by location) or a simple
merge script can minimise the overhead of keeping the config files congruent.

I hope this helps

Simon
Technology Programmer, ATD

-- 
Simon Goodwin <sim...@at...>