Re: [Doxygen-develop] Comment diagrams

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

Hi Stathis,

On Fri, Nov 19, 2004 at 06:53:18PM +0000, Stathis Sideris wrote:
> Hello,
> 
> I'm really glad that you liked ditaa, and that you tought it would be
> useful. :-)
> 
> Before diving too deep into the (120k lines!) code to add the \ditaa and
> \endditaa tags, I would like to ask for some pointers so that I don't
> get lost.
> 
> It seems that I would need to add ditta and edditta to to cmdmapper.cpp
> and cmdmapper.h.

Yes.

> Then I would need to modify config.l I'm not familiar with flex, so this
> will be tricky...

If you look for "dot" in scanner.l and replace it by ("dot"|"ditta")
and cases where "dot" is part of a or'ed construction already just append
a |"ditta" it should be fine. The part in scanner.l is just to skip 
\\ditta (i.e. the escaped version of the command), and not to 
interpret the section in between. I'll review if before including it.

> I would propose to add the following entries in the configuration:
> 
> HAVE_DITAA: whether ditaa processing occurs (like HAVE_DOT)
> DITAA_JAR: filename (with full path) of the ditaa jar file

Ok, just enter a section for these in config.l (one of type bool and the
other of type string). Then you can use Config_getBool("HAVE_DITAA") and
Config_getString("DITAA_JAR") in the rest of code.

> Another thing is how you would pass command line parameters to ditaa
> itself. How about the line after the \ditaa tag being reserved for that?
> Example:
> 
> \ditaa no-shadows round-corners
> +--+
> |  |
> +--+
> \endditaa
> 
> or something of the kind.
> 
> Then I would probably have to add something to docparser.cpp so that
> ditaa starts if the \ditaa tag is found in a comment. Also the
> appropriate changes in htmlgen.cpp for the <img> tags to be inserted (I
> suppose ditta would not be possible for other formats, it doesn't make
> postscript yet!),

Indeed. There are several commands with parameters already, so just look
at handleCommand in docparser.cpp.

> Am I making any sense at all? :-) Any tips/help would be very welcome.

Perfect sense. I think you covered all places where changes are needed.

Regards,
  Dimitri