Re: [Vala] Fw: Extra documentation for vapis on Valadoc

[Florian Brosch <flo brosch gmail com>]

Hey,

> Wow I've never actually looked through the Valadoc source code repository
> before. There are actually a lot of really good examples there.

Thanks.


> Given that, though, can anyone explain how get extra documentation onto
> Valadoc.org?

Take a look at `valadoc --importdir`, `valadoc --import` and `valadoc --wiki.`

--import allows us to import docs from gir-files and .valadoc-files.


.valadoc-files have the following structure:

<documentation-comment>
(<name>|c::<cname>)(::append)?
...


They are primarily used to append examples/widget-images to existing
documentation.


The basic idea:
 - valadoc-example-gen example/*/*.valadoc.examples
 => result#1: wiki files
(http://valadoc.org/#!wiki=gtk+-3.0/example-listing-index)
 => result#2: .valadoc-files

 - generator
 => guided by documentation/packages.xml
 => uses valadoc to generate docs
 => uses wget to fetch images used in gir-files
 => generates index.valadoc files based on packages.xml
 => uses valadoc-example-gen
 => generates widget galleries (.valadoc files, wiki-files, wget)


On 25 September 2013 13:28, Steven Oliver <oliver steven gmail com> wrote:
> Wow I've never actually looked through the Valadoc source code repository
> before. There are actually a lot of really good examples there.
>
> Given that, though, can anyone explain how get extra documentation onto
> Valadoc.org?
>
> Steven N. Oliver
>
>
> On Tue, Sep 24, 2013 at 4:05 PM, Al Thomas <astavale yahoo co uk> wrote:
>
> > From: Steven Oliver <oliver steven gmail com>
> > > To: vala-list <vala-list gnome org>
> > > Sent: Tuesday, 24 September 2013, 19:15
> > > Subject: [Vala] Extra documentation for vapis on Valadoc
> > >
> > >
> > > My
> >  question is how did the extra documentation get there? I looked in the
> > > Glib-2.0 vapi but there's nothing extra there.
> >
> > My understanding is Valadoc is not generated from vapi files.
> >
> > It has it's own markup style ( see http://valadoc.org/#!wiki=markup ) and
> > source code ( see https://gitorious.org/valadoc-org/valadoc-org/ ), but
> > that may not be the whole story because the relevant valadoc file I can
> > find (
> > https://gitorious.org/valadoc-org/valadoc-org/source/6c7d58e17a247438337d75bde80737f0e539fa2b:documentation/glib-2.0/glib-2.0.valadoc)
> >  doesn't seem to contain the GLib.Markup.printf_escaped function you were
> > interested in.
> >
> > Hope that helps,
> >
> > Al
> > _______________________________________________
> > vala-list mailing list
> > vala-list gnome org
> > https://mail.gnome.org/mailman/listinfo/vala-list
> _______________________________________________
> vala-list mailing list
> vala-list gnome org
> https://mail.gnome.org/mailman/listinfo/vala-list