Welcome, Guest. Please login or register. Did you miss your activation email?
Pages: [1]

Author Topic: What documentation does the SFML project make use of?  (Read 2978 times)

0 Members and 1 Guest are viewing this topic.

Mossa TheGreat

  • Newbie
  • *
  • Posts: 6
    • View Profile
What documentation does the SFML project make use of?
« on: December 25, 2008, 12:30:34 am »
Greetings everyone!

I am personally a big fan of how the documentation for SFML have been organized. It is truly extraordinarly well. However, it looks to me like there have been used a great deal of automatic processing of source code information... I like that format and I want something as elegant as that for my project.

Can you please tell me of your documentation generating tool of chooice and what secret techniques you apply using these tools to generate good documentation? (Goes for all talented and working programmers in the area!!!)

PS: Merry Christmas and have a Happy New Year! (Everyone. Not just the working men - also the women) Especially you Laurent.

Sincerely,

Mossa
Logged

Imbue

  • Full Member
  • ***
  • Posts: 104
    • View Profile
What documentation does the SFML project make use of?
« Reply #1 on: December 25, 2008, 01:10:33 am »
The reference is done with Doxygen. It uses special comments from the source code. It's a very widely used tool, I use it in almost all of my C++ projects.

I assume the tutorials are just done by hand.

I agree, though, SFML is well documented for a free open source project.
Logged
Pages: [1]
 

anything