Re: docbook markup in inline docs
- From: "Matthias Clasen" <matthiasc poet de>
- To: <gtk-doc-list gnome org>
- Subject: Re: docbook markup in inline docs
- Date: Thu, 18 Oct 2001 17:37:56 +0200
> >
> > No thanks. But speaking about mainership, wouldn't it be a nice idea
> > to relase a 0.8 with the sgml mode stuff (of course, I should have
included
> > at least a tiny piece of documentation for it). Or is it ok for gtk+ and
> > glib
> > API docs to depend on CVS gtk-doc for proper processing ?
>
> This has typically been the case. I have some intention (never got around
> to actually doing it) of making the default --disable-gtk-doc
> except when you run autogen.sh.
>
> A new release wouldn't hurt, but I wouldn't bother waiting for
> a release to depend on new gtk-doc features.
>
> The most important place for the docs to keep working is the
> autobuild on developer.gnome.org and that pulls the latest gtk-doc
> every time.
Ok, then I'll go ahead and enable --sgml-mode for the gtk/glib/pango api
docs.
> >
> > The enums in Pango often only have G_TYPE_FOO.
>
> None of the above "standard macros" apply to an enumeration type.
> My original comment to Matthias was that I thought that enumeration
> type macros should be with the macro, since I suspect people
> will have trouble grasping the rule: "For PangoWeight,
> there will be a macro PANGO_TYPE_WEIGHT"
>
> I would imagine having immediately after the enumeration docs, something
> like:
>
> PANGO_TYPE_WEIGHT - the GObject type for PangoWeight
>
> I don't think a lot of detail is necessary. If it is, we could
> have a small description and then link to a longer documentation
> section on type macros.
Ok, I will do it like this then.
Matthias
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]