Re: CDATA in source comments



Hi Matthias,

yes I am a pest, but I am not convinced yet.

> 
> 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).

1.) Where do I enable/disable "markup in comments". I run all the gtkdoc-* tools
with --help, but can't find an option for it.

2.) Thats why I was using the CDATA section. This way there is no need to escape
 special characters in source examples. The probelm is that the ending '>' of
the CDATA section is escaped by the gtkdoc toolchain!
> 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.

I don't think that this is neccesary. I'll look tomorrow at the sources and if I
can fix it I bugzilla it, add a patch and let you all know ;-).

Stefan
> 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



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]