[Corelinux-public] Docs temporary resolution

[Frank V. C. <fr...@co...>]

Rik, and others:

After a preliminary look at Doc++ and Doxygen it is my opinion that both
would do fine, with Doxygen having the advantage by the fact that it
appears to be highly configurable (based on the number of configuration
points documented) as well as currently maintained.

BUT...

I do not by any means think that we have to make a decision yet. The
reason being that BOTH these tools can work off of the same tag style at
a minimum. This style is the one commonly used in Java for JavaDoc where
big descriptions are enclosed in /** ... */ comments, and one liners
appear after the /// . Both tools expect these comments ABOVE the target
class, method, macro, etc.

For example:


/**
 This is the explanation about the purpose of the
 class in the header file.
*/

/// Namespace

namespace corelinux
{
   DEFINE_CLASS( OurClass );

   /**
    OurClass is a Great class. That is why we have it
   */

   class OurClass : public Great
   {
   public:

            /// Default Constructor

            OurClass( void );
   };
}

You get the idea. To begin I will take what we have now and tag them up!
This, and the new CLFAQ.HTML document will make it's way into a 0.2.1
distribution probably by sometime Sunday US.


Frank