How can I separate the documentation in two different parts (or level of documentation)?

[GRANGE Aurelien]

Hi everyone,
I am new to doxygen so maybe the question is easy but I don’t find documentation about this.

I want to generate two different documentations from my code :
- One for the user of the library (only about accessible element)
- One complete with all commented annotation (for me for the future). The first one is a subset of this one.

I would like to generate two distinct documentations in two different folder (one for each).

Should I use group {user;dev}? Or is there a best way?

Thanks for your help

Have a nice day
Aurélien

[Andy Dent]

The simple way to generate different sets of documentation is to use two configuration files.

You can then have full flexibility over using additional formatting options for customer-facing documentation, eg: https://realm.io/docs/xamarin/latest/api/ https://realm.io/docs/xamarin/latest/api/ which has custom layout, headers and footers.

You can use different input lists for additional information. Say you have internal build documentation or other “essays” written in Markdown - these can be in a directory that’s ignored by the public API documentation.

A tip - whilst you are editing such additional documentation pages, it’s often useful to have a third configuration file which just processes those files. That way you can have super-quick previewing of the generated results without waiting for a large codebase to be processed.