Re: [Vala] Examples in documentation

[Steven Oliver <oliver steven gmail com>]

My biggest complaint with vala's docs isn't valadoc, it does well enough
for what it is. Also, the comment feature sounds nice as long as the
community takes care of it (eg Wikipedia) but I have seen plenty of wikis
that aren't taken care of too. I worry vala's active community as this
point is still too small for that though. There's only one way to find out
though!

My biggest complaint is more the complete lack of valadoc compatible
comments in the code itself. I would rather see people submit patches that
add valadoc comments to code; _especially_ to the vapis. For example Sqlite
is completely devoid of valadoc comments in it's vapi.

http://unstable.valadoc.org/#!api=sqlite3/Sqlite

I looked up the vapi, it's not difficult to figure out:

http://git.gnome.org/browse/vala/tree/vapi/sqlite3.vapi

Steven N. Oliver


On Thu, Nov 8, 2012 at 9:11 PM, Brian Duffy <brduffy gmail com> wrote:

> Very much looking forward to this feature! What do you think of Luca's
> suggestions? ETA?
>
>
> On Thu, Nov 8, 2012 at 8:33 PM, Florian Brosch <flo brosch gmail com>
> wrote:
>
> > Hey guys,
> >
> > I'm already working on a comment system:
> >
> > http://unstable.valadoc.org/
> >
> >
> > On Thu, Nov 8, 2012 at 1:43 PM, Gilzad Hamuni <gilli4 gmx net> wrote:
> > > Hi all,
> > >
> > > maybe it's already there and I missed to see it. Is it possible to have
> > some account on an existing valadoc-page, so one could add code-examples
> > online rather than working with the markup locally?
> > > Knowing that vala is still evolving, I'm facing one issue that probably
> > could be solved rapidly.
> > > Except of the given tutorials, if someone wants to implement some
> > feature in his application, he either has to
> > > 1) guess how he'd use the vala bindings (requires firm experience with
> > glib) or
> > > 2) he has to derive the vala-code from some existing C-code, that is
> > using the same library or
> > > 3) crawl through some existing vala-projects that would offer an
> > example, somewhere deep inside their source.
> > > Now, once a dev has achieved to have some working code, he might want
> to
> > share this as an example, so others will quickly find out how to use
> > function X from vapi Y.
> > > Wouldn't it boost vala's easy-to-efficient-ratio, if code-examples were
> > attached to the documentation (like on msdn or php.net)? Maybe it could
> > be some great advertising, too "Wow, that's just a three-liner!".
> > > Sorry if this has been discussed before, I couldn't find anything
> > related after a quick search.
> > > Best,
> > >
> > > Gilzad
> > > _______________________________________________
> > > 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
>
>
>
> --
> Duff
>
> _______________________________________________
> vala-list mailing list
> vala-list gnome org
> https://mail.gnome.org/mailman/listinfo/vala-list