[Bug 589091] Re: API docs for libunity
** Changed in: libunity Status: Fix Committed => Fix Released -- You received this bug notification because you are a member of Ubuntu Bugs, which is subscribed to Ubuntu. https://bugs.launchpad.net/bugs/589091 Title: API docs for libunity To manage notifications about this bug go to: https://bugs.launchpad.net/libunity/+bug/589091/+subscriptions -- ubuntu-bugs mailing list ubuntu-bugs@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-bugs
[Bug 589091] Re: API docs for libunity
Marking this as fixed, as libunity finally has now a proper support for valadoc, which can generate standard gtk-doc as well as documented .gir file. Of course there's still the issue that we have very few doc comments in the sources, but that's a different bug. ** No longer affects: unity-2d ** No longer affects: unity ** Changed in: libunity Status: Triaged => Fix Committed ** Changed in: libunity Milestone: None => 6.8.0 -- You received this bug notification because you are a member of Ubuntu Bugs, which is subscribed to Ubuntu. https://bugs.launchpad.net/bugs/589091 Title: API docs for libunity To manage notifications about this bug go to: https://bugs.launchpad.net/libunity/+bug/589091/+subscriptions -- ubuntu-bugs mailing list ubuntu-bugs@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-bugs
[Bug 589091] Re: API docs for libunity
@Michal, you should coordinate with Kevin Wright. He might be looking at similar prospects. Wrt g-ir-doc-tool, I am all for supporting whatever upstream GI choose, but last I checked, and what I hear as well, was that development on it stagnated? -- You received this bug notification because you are a member of Ubuntu Bugs, which is subscribed to Ubuntu. https://bugs.launchpad.net/bugs/589091 Title: API docs for libunity To manage notifications about this bug go to: https://bugs.launchpad.net/libunity/+bug/589091/+subscriptions -- ubuntu-bugs mailing list ubuntu-bugs@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-bugs
[Bug 589091] Re: API docs for libunity
** Description changed: We need to somehow generate API docs for libunity. We want us (and - others) to be able to code in C as well as Vala... - - I am thinking that we might be able to run gtk-doc on the generated .c - and .h files, but it appears that valac strips the doc comment blocks... - If I recall correctly this was not always the case... + others) to be able to code in C as well as Vala, Python and what have + we... -- You received this bug notification because you are a member of Ubuntu Bugs, which is subscribed to Ubuntu. https://bugs.launchpad.net/bugs/589091 Title: API docs for libunity To manage notifications about this bug go to: https://bugs.launchpad.net/libunity/+bug/589091/+subscriptions -- ubuntu-bugs mailing list ubuntu-bugs@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-bugs
[Bug 589091] Re: API docs for libunity
The entire G* stack is moving to generating documentation from the .gir files that are produced by g-ir-scanner, and there's support in valadoc to output gir with the documentation tags, so we'll use this approach. (the final documentation can then be generated from .gir using g-ir-doc- tool, and if that isn't mature enough we can keep using giraffe.) ** Changed in: libunity Assignee: Mikkel Kamstrup Erlandsen (kamstrup) => Michal Hruby (mhr3) -- You received this bug notification because you are a member of Ubuntu Bugs, which is subscribed to Ubuntu. https://bugs.launchpad.net/bugs/589091 Title: API docs for libunity To manage notifications about this bug go to: https://bugs.launchpad.net/libunity/+bug/589091/+subscriptions -- ubuntu-bugs mailing list ubuntu-bugs@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-bugs
[Bug 589091] Re: API docs for libunity
valac shouldn't strip the gtk-doc comments (the ones starting with /** ...). When they are formatted using the correct syntax, rest on the .c files (it actually happens for any libunity/src/unity-*.c !) and so it's possible to use the proper tools to generate the documentation like for any project written in C. Otherwise there's also another tool called valagtkdoc [1] that could help. [1] http://lethalman.hostei.com/valagtkdoc/ -- You received this bug notification because you are a member of Ubuntu Bugs, which is subscribed to Ubuntu. https://bugs.launchpad.net/bugs/589091 Title: API docs for libunity To manage notifications about this bug go to: https://bugs.launchpad.net/libunity/+bug/589091/+subscriptions -- ubuntu-bugs mailing list ubuntu-bugs@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-bugs
[Bug 589091] Re: API docs for libunity
** Changed in: unity-2d Status: New => Triaged -- You received this bug notification because you are a member of Ubuntu Bugs, which is subscribed to Ubuntu. https://bugs.launchpad.net/bugs/589091 Title: API docs for libunity -- ubuntu-bugs mailing list ubuntu-bugs@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-bugs
[Bug 589091] Re: API docs for libunity
** Changed in: libunity (Ubuntu) Status: New => Triaged -- You received this bug notification because you are a member of Ubuntu Bugs, which is subscribed to Ubuntu. https://bugs.launchpad.net/bugs/589091 Title: API docs for libunity -- ubuntu-bugs mailing list ubuntu-bugs@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-bugs
