Hello Theuns,

you probably need to fiddle a little with doxygen's preprocessing options (http://www.stack.nl/~dimitri/doxygen/preprocessing.html <http://www.stack.nl/%7Edimitri/doxygen/preprocessing.html>)

Regards,
André

On 06/28/2012 06:48 PM, Theuns Heydenrych wrote:
HI
I am a newbie

i have the following (just a small extract from a .h file with export functions for a library) i would like to document these function for other users.

extern  "C"  {
    /**
     Return  the  version  for  the  Symgen  API
    */
    SYMGENAPISHARED_EXPORT  char*  getVersionInfo();
    SYMGENAPISHARED_EXPORT  void  initLibrary();
    /**
     The  initial/primary  call  for  creating  a  symbol  generator
     @param[in]  dbDriver:  is  the  driver  name  to  be  used  for  the  
database  connection
     @param[in]  hostname:  is  the  ip  address  or  "localhost"  for  the  
postgres  database
     @param[in]  dbName:  is  the  database  name
     @param[in]  port:  the  port  the  postgres  db  is  listening  on
     @param[in]  username:  login  username  to  be  used  on  postgres  
database
     @param[in]  password:  password  to  be  used  for  login  on  the  
database
     @return  A  handle  to  a  Symbol  Generator  that  is  the  used  in  
other  API  calls
    */
    SYMGENAPISHARED_EXPORT  SymbolGeneratorH  
createGeneratorWithDBCredentials(const  char*  dbDriver,  const  char*  
hostname,
                                                 const  char*  dbName,  int  
port,  const  char*  username,
                                                 const  char*  password);
}
When running the doxygenwizard with default settings doxygen does not generate 
the documentation for the above methods.
But when adding comments to methods in a class it does work.


Please help, i know its something small, but cant figure out what?


------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/


_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Reply via email to