Results 1 to 3 of 3

Thread: Clanlib documentation

  1. #1

    Default Clanlib documentation

    First of all ive got to say i love truly-made SDK that integrates with TR1 and STD. Ogre3d, Irrlicht and other SDKs make their own smart pointers and collections etc - that is truly an onanism.
    But! Ive faced an interesting documentation on ClanLib.
    When i wanted to understand how does clan::Slot works the doxygen-generated documentation said this perfect words:
    Detailed Description

    Perfect. Nothing to say. Then i thought to look up in the code. the code comments are even more wonderful:
    /// \addtogroup clanCore_Signals clanCore Signals
    /// \{

    /// \brief Slot
    That is a control shot in the head, i got it right?

    Then i saw some comments like:
    1) "Here we declary a variable"
    2) "// Initialize ClanLib base components"
    I love the second one. it comes with
    SetupCore setup_core;
    The comment opened my mind on what components do i init, what are the parameters and etc.

    Im i the only one? Or there is a way to get a normal documentation that is not listed on download/install page?
    I generated the doxygen documentation and found it no use at all.

    Examples are giving so much no information about how does Clanlib works, what principles is built on, etc.

    I think you should defenitelly rebuild your documentation and examples. They should explain how it works and how to get it to work, not just show the result.

  2. #2
    ClanLib Developer
    Join Date
    May 2007


    clan::Slot question answered in your other post

    think you should defenitelly rebuild your documentation and examples
    lol. There is no "you". ClanLib is different than the other SDK's that you mention. No company has even been behind it. Nobody owns it. A group of changing developers enhance it, as a hobby

    "We", usually means, anyone who submits patches.

    So, if anyone wants to document lacking areas, they are welcome.

    Note, most developers that use ClanLib have full time jobs and families, and don't have much spare time. Only to code the areas that they require enhancing.

    (clanlib should have a FAQ about this!)

    (Note overview documentation is located in /Documentation/Overview)

  3. #3


    thank you
    i got about the slot class)

Similar Threads

  1. ClanLib 2.2.7 Documentation
    By paladin_knight in forum Official ClanLib SDK Forums
    Replies: 1
    Last Post: 03-28-2011, 02:27 PM
  2. Documentation...
    By sirlich in forum Novashell Game Creation System
    Replies: 1
    Last Post: 10-09-2009, 03:50 AM
  3. ClanLib 0.9 API documentation file format
    By rombust in forum Official ClanLib SDK Forums
    Replies: 3
    Last Post: 10-01-2008, 02:09 PM
  4. How to Build Clanlib documentation on FreeBSD?
    By NVanGogh in forum Official ClanLib SDK Forums
    Replies: 1
    Last Post: 08-13-2008, 11:04 PM
  5. Documentation
    By Caesar in forum Official ClanLib SDK Forums
    Replies: 1
    Last Post: 08-09-2007, 08:42 PM



Posting Permissions

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