newline in documentation

[Greg Wunder]

When generating documentation for a given plugin, if I have a newline character in the string read in for the comments, everything after the newline character '\n' is lost.
Is there a way around this?

_______________________________________________
gstreamer-devel mailing list
[hidden email]
http://lists.freedesktop.org/mailman/listinfo/gstreamer-devel

[Stefan Sauer]

hi greg,
On 08.04.2011 21:54, Greg Wunder wrote:
>
> When generating documentation for a given plugin, if I have a newline
> character in the string read in for the comments, everything after the
> newline character '\n' is lost.
> Is there a way around this?
>
Can you post an example?

Stefan
>
>
> _______________________________________________
> gstreamer-devel mailing list
> [hidden email]
> http://lists.freedesktop.org/mailman/listinfo/gstreamer-devel

_______________________________________________
gstreamer-devel mailing list
[hidden email]
http://lists.freedesktop.org/mailman/listinfo/gstreamer-devel

[Greg Wunder]

Sure, for instance if I have a property in my plug-in that I've installed as such (below):

g_object_class_install_property (gobject_class, PROP_MODELS_PATH, g_param_spec_string("models path", "Models Path",models_path_comments, PROP_MODELS_PATH_DEFAULT, G_PARAM_READWRITE));

If "models_path_comments" (which is a previously defined #define string) has a "\n" in it, anything after the "\n" will be lost in the generated html.

If you need additional code or an example, I can provide.

Greg


-----Original Message-----
From: gstreamer-devel-bounces+gwunder=[hidden email] on behalf of Stefan Kost
Sent: Mon 4/11/2011 10:30 AM
To: [hidden email]
Subject: Re: newline in documentation

hi greg,
On 08.04.2011 21:54, Greg Wunder wrote:
>
> When generating documentation for a given plugin, if I have a newline
> character in the string read in for the comments, everything after the
> newline character '\n' is lost.
> Is there a way around this?
>
Can you post an example?

Stefan
>
>
> _______________________________________________
> gstreamer-devel mailing list
> [hidden email]
> http://lists.freedesktop.org/mailman/listinfo/gstreamer-devel

_______________________________________________
gstreamer-devel mailing list
[hidden email]
http://lists.freedesktop.org/mailman/listinfo/gstreamer-devel

_______________________________________________
gstreamer-devel mailing list
[hidden email]
http://lists.freedesktop.org/mailman/listinfo/gstreamer-devel

[Stefan Sauer]

On 11.04.2011 19:30, Greg Wunder wrote:

>
> Sure, for instance if I have a property in my plug-in that I've
> installed as such (below):
>
> g_object_class_install_property (gobject_class, PROP_MODELS_PATH,
> g_param_spec_string("models path", "Models Path",models_path_comments,
> PROP_MODELS_PATH_DEFAULT, G_PARAM_READWRITE));
>
> If "models_path_comments" (which is a previously defined #define
> string) has a "\n" in it, anything after the "\n" will be lost in the
> generated html.
>
> If you need additional code or an example, I can provide.
>

Just tried it and indeed it does not work. If you want file a bug for
gtk-doc.

Stefan

>
> Greg
>
>
> -----Original Message-----
> From: gstreamer-devel-bounces+gwunder=[hidden email]
> on behalf of Stefan Kost
> Sent: Mon 4/11/2011 10:30 AM
> To: [hidden email]
> Subject: Re: newline in documentation
>
> hi greg,
> On 08.04.2011 21:54, Greg Wunder wrote:
> >
> > When generating documentation for a given plugin, if I have a newline
> > character in the string read in for the comments, everything after the
> > newline character '\n' is lost.
> > Is there a way around this?
> >
> Can you post an example?
>
> Stefan
> >
> >
> > _______________________________________________
> > gstreamer-devel mailing list
> > [hidden email]
> > http://lists.freedesktop.org/mailman/listinfo/gstreamer-devel
>
> _______________________________________________
> gstreamer-devel mailing list
> [hidden email]
> http://lists.freedesktop.org/mailman/listinfo/gstreamer-devel
>
>
> _______________________________________________
> gstreamer-devel mailing list
> [hidden email]
> http://lists.freedesktop.org/mailman/listinfo/gstreamer-devel

_______________________________________________
gstreamer-devel mailing list
[hidden email]
http://lists.freedesktop.org/mailman/listinfo/gstreamer-devel