Lighthouse has a new layout. Prefer the old one? Return to the old layout, and switch back any time from the link at the top of each page.

Generate documentation

#62

We should generate some kind of documentation to the API of libiphone. A couple of functions are already documented with doc comments so this should be straightforward. The candidates probably are doxygen and perhaps gtk-doc (I think the html doc is much easier to read but than it's just a matter of the right conversion templates I guess...).

Reported by Martin S. · July 25th, 2009 @ 12:45 PM

State: resolved
Milestone: 1.0 Release
Assigned to: Matt Colyer Matt Colyer

Activity

  1. Martin S.
    Martin S.
    • State changed from new to open
    • Assigned user set to Matt Colyer
    • Milestone changed from 1.2.0 Release to 1.0 Release

    Was just experimenting with doxygen and it now generates nice docs for the public interface.
    To test just run something along this:

    [libiphone/]# doxygen doxygen.cfg && firefox docs/html/index.html

    July 25th, 2009 @ 04:18 PM

  2. Matt Colyer
    Matt Colyer

    I can't get this to apply after I merged libiphone 1.0 api stuff, can you rebase this?

    July 27th, 2009 @ 02:39 AM

  3. Martin S.
    Martin S.

    It's already in with commit da94f0ebc7232e8e9d0e629fe559b7bc93d9a1c6.
    Should we autogenerate the documentation and distribute in make dist and packages correspondingly?

    Example of the generated docs: http://media.sukimashita.com/temp/libiphone/index.html

    July 27th, 2009 @ 06:23 AM

  4. Matt Colyer
    Matt Colyer
    • State changed from open to resolved

    July 28th, 2009 @ 03:01 AM

Please Sign in or create a free account to add a new ticket.

With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.