[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-kdoc
Subject:    Kdoc & namespaces
From:       Kari Uusitalo <u130557 () cs ! tut ! fi>
Date:       1999-08-30 9:48:04
[Download RAW message or body]


Hi,

I have been experimenting with KDOC2. I have always liked Java's
javadoc tool and the features it has provided. It was really nice
to notice that similar tool is under development for C++.

I have found a couple errors from the current version (i.e., 2.0a12):

1) It doesn't interpret namespaces correctly. That is, it doesn't
understand them and fails to produce documentation to a class that is
inside a namespace. In fact, I think it interprets "namespace something"
to a global and therefore the whole class definition inside it is lost..
The example below does not work OK even it should. If you comment the
namespace statement and its braces the example works OK.

2) This is quite minor, but just to inform that keyword @ref does
not work entirely similarly as keyword @see as it should (?). Look also
at the example below.

Especially, the namespace problem is quite fatal for me because I use
them extensively in my project. Is it somehow possible to just forget
about the namespaces while the code is documented? That is, the
documentation is done like the namespace definitions would not exit
in the code.

BR,

Kari
u130557@cs.tut.fi

The example:

namespace test
{
  /**
   * Long description..
   *
   * @short Short description..
   * @author KU
   * @version 1.0
   */
  class MyTest
  {
    public:
      /**
       * Mytest constructor.
       */
      Mytest() {}
      
      /**
       * Text with a reference that does not work @ref #setInt even it
       * should? With the @see keyword below it works OK.
       * This type of reference works @ref MyTest::setInt.
       * @see #setInt
       */
      getInt();
      
      /**
       * Text...
       */
      setInt();
  };
}

[prev in list] [next in list] [prev in thread] [next in thread]