Doxygen problem

This is a discussion on Doxygen problem within the Tech Board forums, part of the Community Boards category; Hi there, I'm having trouble getting doxygen (1.7.3) to print file name for an enumeration or typedef. Following its documentation: ...

  1. #1
    Registered User
    Join Date
    Aug 2010
    Location
    Poland
    Posts
    681

    Doxygen problem

    Hi there,

    I'm having trouble getting doxygen (1.7.3) to print file name for an enumeration or typedef.

    Following its documentation:
    Doxygen

    It is easy to add a nice hyperlink to class definition. All I need to do is:

    Code:
    ////////////////////////////////////////////////////////////////////////////////
    ///
    /// @class token ssc/lexer/token.hpp
    /// @brief Class holding information about single token.
    ///
    ////////////////////////////////////////////////////////////////////////////////
    class token {
    ...
    };
    This nicely documents class 'token' and effectively creates a hyperlink to file in which it is declared. I would like to do same for enums and typedefs. Unfortunately @enum and @typedef do not have an additional <file-name> parameter (as seen in the documentation), thus writing:

    Code:
    ////////////////////////////////////////////////////////////////////////////////
    ///
    /// @typedef token_sequence ssc/lexer/token.hpp
    /// @brief Token sequence.
    ///
    ////////////////////////////////////////////////////////////////////////////////
    typedef std::vector<token> token_sequence;
    results in an obvious error:

    D:/.../ssc/lexer/token.hpp:110: warning: documented function `token_sequence ssc lexer token ssc::hpp' was not declared or defined.
    So my question is: is there a nice way to solve this (similar to @class) or do I need to hardcore the hyperlink? The files (and namespaces) are all properly documented (the class is defined in the same file as the typedef and class' hyperlink DOES work).

    Thanks.
    I never put signature, but I decided to make an exception.

  2. #2
    and the hat of wrongness Salem's Avatar
    Join Date
    Aug 2001
    Location
    The edge of the known universe
    Posts
    32,437
    I've only got some suggestions for things to try.

    Doxygen
    Doxygen

    Looking at it, it seems that class is "special" in that you can separate declaration and implementation.
    But an enum is just a declaration, so you document it where you declare it.
    If you dance barefoot on the broken glass of undefined behaviour, you've got to expect the occasional cut.
    If at first you don't succeed, try writing your phone number on the exam paper.
    I support http://www.ukip.org/ as the first necessary step to a free Europe.

  3. #3
    Registered User
    Join Date
    Aug 2010
    Location
    Poland
    Posts
    681
    Thanks for the feedback.

    After writing this I realised that what I wanted to do was rather stupid, since classes contain more information and thus they have separate sub-pages.
    I never put signature, but I decided to make an exception.

Popular pages Recent additions subscribe to a feed

Similar Threads

  1. Doxygen maps
    By TIMBERings in forum Tech Board
    Replies: 0
    Last Post: 04-26-2010, 12:47 AM
  2. Doxygen failing
    By Elysia in forum A Brief History of Cprogramming.com
    Replies: 19
    Last Post: 04-16-2008, 01:24 PM
  3. Documenting with Doxygen
    By Mario F. in forum C++ Programming
    Replies: 4
    Last Post: 07-28-2006, 03:17 AM
  4. doxygen and functions
    By zxcv in forum Tech Board
    Replies: 1
    Last Post: 05-13-2006, 04:37 PM
  5. doxygen
    By Magos in forum Tech Board
    Replies: 1
    Last Post: 02-15-2006, 09:44 PM

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21