tags:

views:

25

answers:

0

I'd like to use doxygen to comment code line-by-line just like in the \dontinclude example, but I want to do it within the file, not in a completely separate file as in that example. So taking the doxygen example, something like this:

/**  \dontinclude thisfile.cpp
  *  Our main function starts like this:
  *  \skip main
  *  \until {
  *  First we create a object \c t of the Test class.
  *  \skipline Test
  *  Then we call the example member function 
  *  \line example
  *  After that our little test routine ends.
  *  \line }
  */
void main()
{
  Test t;
  t.example();
}

Or even better:

/// \dontinclude thisfile.cpp
/// Our main function starts like this:
/// \skip main
/// \until {
void main()
{
  /// First we create a object \c t of the Test class.
  /// \skipline Test
  Test t;

  /// Then we call the example member function 
  /// \line example
  t.example();

/// After that our little test routine ends.
/// \line }
}

However the patterns in \skip and \skipline keep finding themselves, and there doesn't seem to be a way to even arbitrarily skip the internal file "pointer" in doxygen ahead by an arbitrary amount to work around it.

Is this even possible?