Re: CDATA in source comments

[Stefan Kost <kost imn htwk-leipzig de>]

Hi again,

I looked at the sources right now and the only tool that contains > & &
lt; is gtkdoc-mkdb and in there ConvertSGMLChars and CreateValidSGML.
The first one is not called often and these calls seems to be fine.
And then I've checked all the CreateValidSGML invocations.
I don't yet have found the place where it produces The function description
(should be somehwere around OutputFunction() ).
So I can't submit a patch yet. Maybe I should really look at the issue after
some pause....

Stefan

Matthias Clasen wrote:
> On Tue, 2004-11-23 at 14:32 +0100, Stefan Kost wrote:
> 
>>Hi Matthias,
>>
>>thats what I was thinking, but it does not. Using:
>>/**
>>  * ...
>>  * <informalexample><programlisting>
>>  * g_object_get(bla,"peng",&peng);
>>  * </programlisting>
>>  * </informalexample>
>>  */
>>
>>produces an parser error abount an EntityRef that needs to be compleeted by a
>>';' - means the '&' infront of 'peng' is not escaped to become '&amp;'.
>>Thats my I was trying to use a CDATA section 9to avoid manually escaping all the
>> special chars.
>>
> 
> 
> Ah, I got it wrong. If markup in comments is enabled it does *not*
> escape & < > (thinking about it, that is as it has to be). I don't think
> adding support for marked sections is the right thing. If we want to
> avoid markup in cases like this, we could try to come up with a new 
> shorthand notation for examples in comments. Something like
> 
> /**
>  * ...
>  * bla bla bla 
>  * bla bla bla
>  *
>  * ----
>  * g_object_get (bla, "peng", &peng);
>  * ----
>  *
>  * more bla bla 
>  * ...
>  */
> 
> But I'm not 100% convinced this is a good idea either.
> 
> Matthias
> 
> 

-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

begin:vcard
fn:Stefan Kost
n:Kost;Stefan
org:HTWK Leipzig;FB. IMN
adr:;;Postfach 301166;Leipzig;;04251;Germany
email;internet:kost imn htwk-leipzig de
title:Dipl. Informatiker
tel;work:+49341 30766440
tel;home:+49341 2253538
tel;cell:+49178 3183742
x-mozilla-html:FALSE
url:http://www.imn.htwk-leipzig.de/~kost/about.html
version:2.1
end:vcard