views:

15

answers:

0

Hi

I have a protocol in a header file with several methods. I am using Doxygen to document the APIs. What I am trying to do is to put the Doxygen comments 'outside' of the protocol, so as to enable readability of the whole protocol without the comments.

Doxygen has a structural command for protocol so i can put something like this at the beginning of the file

/** \protocol ProtocolName

But I can't do the same for the methods of the protocol (i.e. put them at the beginning of the file). I've tried

defining the file first through /** \file filename 
/** \fn
/** \ref

but none work. The documentation (on p.23) says these are the structural commands

\struct  \union \enum  \fn \var \def \typedef \file \namespace \package \interface

What is the best way to solve this?

thank you

P