Doxygen: How to create extra class docs outside of source code?

Question

I'd like to add verbose information about my core classes without embedding it all above those classes in the source file.

For instance, I'd like to create a separate file with voluminous info about class Foo, probably in markdown or html. Then when I view class Foo in the doxygen-created output, I'd like the class page for Foo to contain all my voluminous and beautifully marked up documentation in its details section along with any other comments I did put above class Foo.

Is this possible?

Eric Miller · Accepted Answer · 2013-04-17 11:53:56Z

3

If you currently have a file Foo.h

/**
A short description of class Foo.
*/
class Foo
{
}

You can add additional documentation in a file with a .dox extension (let's call it Foo.dox)

/**
More details about Foo.

Maybe you only want to distribute this to your nicer customers.

@class Foo Foo.h
*/

Don't forget to add the .dox file to the INPUT line of your configuration file

INPUT = \
Foo.h Foo.dox

answered Apr 17, 2013 at 11:53

Eric Miller

2,03118 silver badges13 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

charliep Over a year ago

Well that was easy after all. :) Thanks!

Julian Mann Over a year ago

Another use case might be to allow public access to documentation source but not source code, so that consumers of your APIs can send pull requests that add descriptions and examples.

einpoklum Over a year ago

1. Will this work for types, functions, constants, etc? Or is it just for classes? 2. If you specify the "namespace path" of a class, will it appear in the documentation or just be used to resolve the class you're referring to?

Collectives™ on Stack Overflow

Doxygen: How to create extra class docs outside of source code?

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related