Phil Edwards | 1 Nov 2002 06:32

Disabled conditional sections still generate output

trouble.html tells me I can report a bug to the developers mailing list.  So
here we go...

We have a large number of comment blocks that look like this:

    /**
     *   <at> if maint
     *   <at> brief Some short description.
     *   <at> param  stuff goes here
     *   <at> return   stuff goes here
     *
     *  Longer description here.
     *   <at> endif
    */
    void the_function (the params) {......}

Note that there is no unconditional text at all.  And in 1.2.16, nothing at
all would be generated when "maint" was not enabled.  And that was excellent.

I've just tried 1.2.18, and the function now shows up in the output, with the
special tags being emitted directly as HTML, but with none of the extra text.
The block above, for example, would have a text section consisting of

     <at> brief <at> param <at> return

with "brief <at> param" linked as a mailto:.

What further information can I provide to help figure out what's going wrong?

Phil
(Continue reading)

Dimitri van Heesch | 1 Nov 2002 09:25
Picon
Favicon

Re: Disabled conditional sections still generate output

On Fri, Nov 01, 2002 at 12:32:41AM -0500, Phil Edwards wrote:
> trouble.html tells me I can report a bug to the developers mailing list.  So
> here we go...
> 
> We have a large number of comment blocks that look like this:
> 
>     /**
>      *   <at> if maint
>      *   <at> brief Some short description.
>      *   <at> param  stuff goes here
>      *   <at> return   stuff goes here
>      *
>      *  Longer description here.
>      *   <at> endif
>     */
>     void the_function (the params) {......}
> 
> Note that there is no unconditional text at all.  And in 1.2.16, nothing at
> all would be generated when "maint" was not enabled.  And that was excellent.
> 
> I've just tried 1.2.18, and the function now shows up in the output, with the
> special tags being emitted directly as HTML, but with none of the extra text.
> The block above, for example, would have a text section consisting of
> 
>      <at> brief <at> param <at> return
> 
> with "brief <at> param" linked as a mailto:.
> 
> 
> What further information can I provide to help figure out what's going wrong?
(Continue reading)

Phil Edwards | 1 Nov 2002 23:36

Re: Disabled conditional sections still generate output


I built 1.2.18-20021030 (providing the tarballs of the CVS repository is
a great idea, by the way), and the output is correct again.

On behalf of the libstdc++ maintainers, thanks!

Phil

--

-- 
I would therefore like to posit that computing's central challenge, viz. "How
not to make a mess of it," has /not/ been met.
                                                 - Edsger Dijkstra, 1930-2002

-------------------------------------------------------
This sf.net email is sponsored by: See the NEW Palm 
Tungsten T handheld. Power & Color in a compact size!
http://ads.sourceforge.net/cgi-bin/redirect.pl?palm0001en
Cormac Twomey | 7 Nov 2002 02:53

xml encoding of <at> see seems bogus

I have noticed that  <at> see is encoded into xml as:

<simplesect kind=">see">
   <para>
      <ref refid="blahblah_1a22" kindref="member">foo()</ref>
   </para>
</simplesect>

Now, it is clearly illegal xml to have the > symbol in the literal ">see" on the first line. Is it safe to assume
that the greater
than symbol squeaked in by accident? Here is the offending line of code, in xmldocvisitor.cpp:

void XmlDocVisitor::visitPre(DocSimpleSect *s)
{
  m_t << "<simplesect kind=\">";   // <-- Error
  switch(s->type())
.
.

The offending line needs to have the greater-than removed:
  m_t << "<simplesect kind=\"";

--Cormac Twomey

-------------------------------------------------------
This sf.net email is sponsored by: See the NEW Palm 
Tungsten T handheld. Power & Color in a compact size!
http://ads.sourceforge.net/cgi-bin/redirect.pl?palm0001en
Kilian Kiko | 11 Nov 2002 17:57
Picon

XML Output

Is it possible to get a single file output instead of a file per class?
So that all classes are just separated through their compounddef tag?

--

-- 
Regards,
 Kilian

-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
Johan Eriksson | 12 Nov 2002 08:29
Picon
Picon

Re: XML Output


Kilian Kiko wrote:
> Is it possible to get a single file output instead of a file per class?
This is something that I have wondered about too. I would like to have 
the possibility to get it something like the RTF output, divided into 
sections and subsections, etc.

Or does it exist a seperate tool that compile all the XML files into one 
large file, alternatively
keeping the XML files but the tool compile it into one document a' la 
RTF while viewing or printing.

/Regards,
          Johan

> So that all classes are just separated through their compounddef tag?
> 
> 

-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
Carsten Zerbst | 12 Nov 2002 10:36
Picon

Extracting parameter type from XML ?

Hello,
I struggle how to extract the parameter type from the xml file using 
doxmlparser. I get the parameter name from 

  printf("param decl %s\n", param->declarationName()->latin1());

but how to get the paramter type ?

Thanks, Carsten

-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
Cormac Twomey | 12 Nov 2002 23:33

[Patch] Re: XML Output

I did something like this using XML External entities. I have a file, called master.xml, which merges all of
the files together. It
looks like this:

<?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?>
<!DOCTYPE doxygengroup [
 <!ENTITY IInterface1 SYSTEM "doxygen/xml/interfaceIInterface1.xml">
 <!ENTITY IInterface2 SYSTEM "doxygen/xml/interfaceIInterface2.xml">
 <!ENTITY IInterface3 SYSTEM "doxygen/xml/interfaceIInterface3.xml">
 <!ENTITY IInterface4 SYSTEM "doxygen/xml/interfaceIInterface4.xml">
 <!ENTITY IInterface5 SYSTEM "doxygen/xml/interfaceIInterface5.xml">
]>

<doxygengroup>
 &IInterface1;
 &IInterface2;
 &IInterface3;
 &IInterface4;
 &IInterface5;
</doxygengroup>

At this point I would be able to transform master.xml using xsl stylesheets, except that each of the xml
files generated by doxygen
has an xml header of the form <?xml ... ?> which I don't think should appear in an xml external entity;
regardless, it isn't
accepted by my xsl transformer.

To solve this problem, I looked at the doxygen configuration variables available to control the xml
header, but unfortunately there
isn't any to enable/disable the header. So I patched xmlgen.cpp to provide this for me (introduced new
(Continue reading)

Johannes.Klein | 14 Nov 2002 15:27
Favicon

xml: special characters


Hi,

If the GENERATE_XML   option is set to YES and special characters like '>', '&', '$' etc. are used in the comment, doxygen  comes up with  error messages of the type:

Error: Unexpected character `<'

It removes the character in the xml output (where as in HTML it stays unchanged).

Is this intended or is it a bug?

It should rather transform  the characters, to e.g.  "&lt;" , as it did in version 1.2.17.

Regards
Johannes

Enter your application into the Symbian developer contest and win great prizes http://www.symbian.com/news/2002/apps-dvlprs-feat.html Closes December 1st!

**********************************************************************
Symbian Ltd is a company registered in England and Wales with registered number 01796587 and registered office at 19 Harcourt Street, London, W1H 4HF, UK.
This message is intended only for use by the named addressee and may contain privileged and/or confidential information. If you are not the named addressee you should not disseminate, copy or take any action in reliance on it. If you have received this message in error please notify postmaster <at> symbian.com and delete the message and any attachments accompanying it immediately. Symbian does not accept liability for any corruption, interception, amendment, tampering or viruses occuring to this message in transit or for any message sent by its employees which is not in compliance with Symbian corporate policy.
**********************************************************************
Dimitri van Heesch | 14 Nov 2002 19:02
Picon
Favicon

Re: Extracting parameter type from XML ?

On Tue, Nov 12, 2002 at 10:36:09AM +0100, Carsten Zerbst wrote:
> Hello,
> I struggle how to extract the parameter type from the xml file using 
> doxmlparser. I get the parameter name from 
> 
> 
>   printf("param decl %s\n", param->declarationName()->latin1());
> 
> but how to get the paramter type ?

Using param->type() of course ;-)
The result is not a string but can be converted to one using something 
like this:

QString linkedTextToString(ILinkedTextIterator *ti)
{
  QString result;
  ILinkedText *lt=0;
  for (ti->toFirst();(lt=ti->current());ti->toNext())
  {
    switch (lt->kind())
    {
      case ILinkedText::Kind_Text: // plain text
        result+=dynamic_cast<ILT_Text*>(lt)->text()->latin1(); break;
      case ILinkedText::Kind_Ref:  // a link
        result+=dynamic_cast<ILT_Ref *>(lt)->text()->latin1(); break;
    }
  }
  return result;
}

Regards,
  Dimitri

-------------------------------------------------------
This sf.net email is sponsored by: To learn the basics of securing 
your web site with SSL, click here to get a FREE TRIAL of a Thawte 
Server Certificate: http://www.gothawte.com/rd524.html

Gmane