Quantcast

Documentation for typedefs not generated, C++ code

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Documentation for typedefs not generated, C++ code

Sam Varshavchik
With doxygen-1.8.12, in an otherwise empty directory:

$ doxygen -g


Configuration file `Doxyfile' created.

Now edit the configuration file and enter

  doxygen Doxyfile

to generate the documentation for your project

$ cat >foo.hh

//! A documented typedef

typedef int zz;
[mrsam@octopus zz]$ doxygen
Searching for include files..

The resulting documentation in the html directory is empty. The typedef is  
not documented. The generated documentation does have a "Files" section,  
that dutifully includes the foo.hh file, showing the typedef inside it, but  
with the doxygen comment block removed.

Replacing the typedef with "class zz{};" results in the expected output.

I must be missing something obvious.

------------------------------------------------------------------------------
Developer Access Program for Intel Xeon Phi Processors
Access to Intel Xeon Phi processor-based developer platforms.
With one year of Intel Parallel Studio XE.
Training and support from Colfax.
Order your platform today.http://sdm.link/xeonphi
_______________________________________________
Doxygen-users mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-users

attachment0 (817 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: Documentation for typedefs not generated, C++ code

Dimitri van Heesch-2
Hi Sam,

See this FAQ: http://www.doxygen.org/manual/faq.html#faq_extract_all

Regards,
  Dimitri

> On 07 Dec 2016, at 18:04 , Sam Varshavchik <[hidden email]> wrote:
>
> With doxygen-1.8.12, in an otherwise empty directory:
>
> $ doxygen -g
>
>
> Configuration file `Doxyfile' created.
>
> Now edit the configuration file and enter
>
> doxygen Doxyfile
>
> to generate the documentation for your project
>
> $ cat >foo.hh
>
> //! A documented typedef
>
> typedef int zz;
> [mrsam@octopus zz]$ doxygen
> Searching for include files..
>
> The resulting documentation in the html directory is empty. The typedef is not documented. The generated documentation does have a "Files" section, that dutifully includes the foo.hh file, showing the typedef inside it, but with the doxygen comment block removed.
>
> Replacing the typedef with "class zz{};" results in the expected output.
>
> I must be missing something obvious.
> ------------------------------------------------------------------------------
> Developer Access Program for Intel Xeon Phi Processors
> Access to Intel Xeon Phi processor-based developer platforms.
> With one year of Intel Parallel Studio XE.
> Training and support from Colfax.
> Order your platform today.http://sdm.link/xeonphi_______________________________________________
> Doxygen-users mailing list
> [hidden email]
> https://lists.sourceforge.net/lists/listinfo/doxygen-users


------------------------------------------------------------------------------
Developer Access Program for Intel Xeon Phi Processors
Access to Intel Xeon Phi processor-based developer platforms.
With one year of Intel Parallel Studio XE.
Training and support from Colfax.
Order your platform today.http://sdm.link/xeonphi
_______________________________________________
Doxygen-users mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
Loading...