Re: [Vala] @see



I guess for the "See Also" section, for instance a Gtk::FileChooser could
have a see-also for a GIO::File. Or, if you have a constructor which takes
a string and an int, but also one which takes an arm and a leg (should you
define such types), and are planning on documenting them in-depth, you
could see-also them to each other. Another use would be to see-also from an
actual property to its getter and setter function.

But then again, I don't think anything in Valadoc uses it (and Gtk is
inconsistent with properties, getters and setters, which is silly). I guess
it's up to you.

On 20 July 2012 16:30, David Boesner <david boesner googlemail com> wrote:

Hi everyone,

I'm commenting my Vala code at the moment.
I'm checking out this site: http://valadoc.org/#!wiki=markup

And I wonder what the @see taglet should be good for.
I'm missing an exlpaination there.

Thanks in advande

David

_______________________________________________
vala-list mailing list
vala-list gnome org
https://mail.gnome.org/mailman/listinfo/vala-list




-- 
_____________________
Filip Lamparski - FB <https://www.facebook.com/filip.lamparski> -
G+<https://plus.google.com/105688569486178456264/posts>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]