Without autotools

[Connor Behan]

I have a very small program called mebitag and I'd like to document its
library without an ugly doxygen logo on the html. I think this is a
reasonable request but every time I try gtk-doc, it tells me I get 3%
documentation and fills the html files with data structures that are all
missing comments. I am doing this all from the libmebi directory which
contains:

Makefile  dbops.h    dbquery.h  fileio.c  mebitag.7
dbops.c   dbquery.c  errors.h   fileio.h  types.h

The comments all follow this format: http://pastebin.com/mc8edc76

What I'm doing (using gtk-doc.make as a guide) is:

gtkdoc-scan --module=libmebi --source-dir=.
gtkdoc-scangobj --module=libmebi --output-dir=.

Then this fails because I hate figuring out how to quote shell variables
so I then run:

gcc -o libmebi-scan `pkg-config --cflags --libs gtk+-2.0` libmebi-scan.c

Then I take every file that ends in .new and make a copy of it that
doesn't end in .new, then I run:

gtkdoc-mktmpl --module=libmebi
gtkdoc-mkdb --module=libmebi --output-format=xml
--main-sgml-file=libmebi.sgml
mkdir html && cd html && gtkdoc-mkhtml --path=. libmebi ../libmebi.sgml

This produces the empty html and I have tried for days without finding a
way around that. I could edit the html to put comments in but that
greatly defeats the purpose. Any help would be much appreciated.
_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

[Nicola Fontana-3]

Il giorno Tue, 11 Aug 2009 13:48:33 -0400
Connor Behan <connor.behan@...> ha scritto:

> The comments all follow this format: http://pastebin.com/mc8edc76

Hi,

the docblocks look good to me: the problem is not there.

> What I'm doing (using gtk-doc.make as a guide) is:
>
> gtkdoc-scan --module=libmebi --source-dir=.
> gtkdoc-scangobj --module=libmebi --output-dir=.
>
> Then this fails because I hate figuring out how to quote shell

gtkdoc-scangobj requires a project based on GObject and if libmebi is
not such kind of project this step is useless (in your case harmful
too). Just touch the required files, probably:

libmebi.types
libmebi.args
libmebi.hierarchy
libmebi.interfaces
libmebi.prerequisites
libmebi.signals

and jump directly to the gtkdoc-mktmpl step. There will probably be
other adjustments to do: a link to the sources would be more helpful.

Ciao
--
Nicola
_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

[Stefan Kost]

hi,

On 3:33:43 pm 12/08/2009 Nicola Fontana <ntd@...> wrote:

> Il giorno Tue, 11 Aug 2009 13:48:33 -0400
> Connor Behan <connor.behan@...> ha scritto:
>
> >  The comments all follow this format: http://pastebin.com/mc8edc76
>
> Hi,
>
> the docblocks look good to me: the problem is not there.
>
> >  What I'm doing (using gtk-doc.make as a guide) is:
> >
> >  gtkdoc-scan --module=libmebi --source-dir=.
> >  gtkdoc-scangobj --module=libmebi --output-dir=.
> >
> >  Then this fails because I hate figuring out how to quote shell

Whats the error?

>
> gtkdoc-scangobj requires a project based on GObject and if libmebi is
> not such kind of project this step is useless (in your case harmful
> too). Just touch the required files, probably:
>
> libmebi.types
> libmebi.args
> libmebi.hierarchy
> libmebi.interfaces
> libmebi.prerequisites
> libmebi.signals
>
> and jump directly to the gtkdoc-mktmpl step. There will probably be
> other adjustments to do: a link to the sources would be more helpful.
>

If you have the doc-comment inside the sources, you can also skip the
gtkdoc-mktmpl step. Users of autotools get the same behaviour when running
gtkdocize --flavour=no-tmpl.

Stefan

> Ciao
> --
> Nicola
> _______________________________________________
> gtk-doc-list mailing list
> gtk-doc-list@...
> http://mail.gnome.org/mailman/listinfo/gtk-doc-list

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

[Connor Behan]

The shell quoting failed when I tried CC="gcc" CC='gcc' CC=\"gcc\" and
CC=\'gcc\' when passing variables to the perl script. However if
gtkdoc-scangobj is harmful for my project I guess that point is moot.

The source is here: https://sourceforge.net/projects/mebitag/

I settled on NaturalDocs because I didn't want to spend more time
getting documentation working than writing the actual program. It
doesn't have full C support but I like the readability I get so maybe
this gtkdoc problem isn't a priority for me anymore.
_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list