tags:

views:

14

answers:

0
Q: 

Doxygen documentation - how to filter method by annotation (e.g. @api)

We are currently using Doxygen to generate the API.

We have put all around the framework annotation as "@api" to tell the developer is allowed to rely on this method since their name won't change.

/**
 * method description
 *
 * @api 
 */
 function foo() {...}

I am looking for a way to only include the methods with these @api annotations in my API documentation.

I had a closer look into the option reference http://www.stack.nl/~dimitri/doxygen/config.html but didn't spot anything that may help. I wonder if that is possible with Doxygen...

related questions

Create Annotation instance with defaults, in Java
Scanning Java annotations at runtime
Use AJAX instead of TagLib?
Compass Search Annotations cause compiler errors
How to use Hibernate @Any-related annotations?
Should a method that implements an interface method be annotated with @Override
Which anotation should I use: @IdClass or @EmbeddedId
How do I make vim indent java annotations correctly?
Setting default values for columns in JPA
Xml configuration versus Annotation based configuration
Generic, annotation-driven event notification frameworks
Spring-MVC Problem using @Controller on controller implementing an interface
Annotated Spring-MVC controller not recognized when controller extends interface
Struts2 Annotation-Validators for Invalid Chars
Annotations on Interfaces?
When Using Dynamic Proxies, how do I access the underlying object's Annotations?
Another JPA Question
How can I get access to the HttpServletRequest object when using Java Web Services
Java annotations for design patterns?
What is effect of "__callback" SAL annotation?
How do I force a Java subclass to define an Annotation?
When do you use Java's @Override annotation and why?
Is it worth the effort to move from a hand crafted hibernate mapping file to annotaions?
Java Annotations
Annotating YouTube videos programatically