Re: [Doxygen-users] MSDN Style

[Dimitri v. H. <di...@st...>]

On Sat, Nov 10, 2001 at 03:28:32PM +0300, Aleksandr Vital%evic Celpanov wrote:
> 	I have a some questions.
> 	1. What is target of restructuring doxygen? There are a 2
> different ways, in my opinion.
> a) sources -> doxygen_parser.exe -> xml -> latexgen -> latex
> 							-> htmlgen ->
> html
> 							...
> 			
> b) sources -> doxygen_parser.lib + xmlgen -> xml
> 		-> doxygen_parser.lib + htmlgen -> html

What I'm aiming for is:

sources -> doxygen.exe (incl xmlgen) -> xml -> 
   htmlgen.exe (using doxygen_xmlparser.lib) -> html

How doxygen_xmlparser.lib will evolve can be seen in addon/xmlparse.

> 
> 	2. Will doxygen_parser parse comments (\brief, \param)? 

For \brief there will be (already is in fact) a different section.
\param will be a specific xml command.

For instance 

    /*! \brief A method.
     *
     *  \param b an integer.
     */

will result in:

        <briefdescription>
          <para>
            A method. 
          </para>
        </briefdescription>
        <detaileddescription>
          <para>
            <parameterlist kind="param">
              <parametername>b</parametername>
              <parameterdescription><para>an integer. </para>
              </parameterdescription>
            </parameterlist>
          </para>
        </detaileddescription>

Please look at the current XML output for more details.

> If it
> will, how it can parse
> specific for output tags, like \htmlonly ? 

Commands like \htmlonly will either disappear or turned into some 
internally unformatted tags like <htmlonly>...</htmlonly>. I haven't
decided yet.

> 	3. Will Doxyfile be sharable for parser & latexgen & etc. and
> where it will be.

The idea is that the configuration file parser is separate library,
containing the options for the engine only. Output formats can extend
the config file with specific options. So it is the output generators that
will generate the template configuration file for a specific format, but
doing so will be easy for the programmer and use a common library (part of
the doxygen distribution).

> 	4. Do you want to split current version of doxygen to parser,
> latextgen, htmlgen, etc
> or you stay latex, htmlgen etc. in doxygen and new doxygen struct will
> creating for new output formats only.

For the time being the current output generators will be kept and maintained,
but in the end they will be removed and replaced by separate executables,
all based on the same xml output.

> 	Other questions depends on aforesaid.

I open for questions/suggestions. Things can still change if needed ;-)

Regards,
  Dimitri