Results 1 to 2 of 2

Thread: Documentation

  1. #1

    Default Documentation

    Hi,
    I've recently started a project that uses clanlib and despite the library being almost everything I want overall, but documentation is sorely lacking.

    I would like to contribute in some way to making the documentation better. I won't write huge tutorials, but I might document a function here or there, as I use them and find out about them. If the developers/maintainers are interested, PM me

  2. #2
    ClanLib Developer
    Join Date
    Sep 2006
    Location
    Denmark
    Posts
    554

    Default

    The API documentation is generated from the header files in the source code. If you want to supply documentation patches are you are more than welcome. To do this you need to make your changes in a subversion checkout of clanlib, then generate a patch using svn and submit that to the forum.

    See the PATCHES file that came along with clanlib's source for further information.

Similar Threads

  1. Documentation bug: please include OSX equivalents to hotkeys
    By whisperstorm in forum Novashell Game Creation System
    Replies: 2
    Last Post: 01-13-2007, 03:55 AM
  2. Unofficial Novashell Scripting API Documentation Thread
    By Ian in forum Novashell Game Creation System
    Replies: 5
    Last Post: 01-08-2007, 07:54 AM
  3. Generating documentation
    By TauCeti in forum Official ClanLib SDK Forums
    Replies: 1
    Last Post: 10-30-2006, 01:55 PM

Bookmarks

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •