Issue #64 resolved
Oscar Netzahual created an issue

Optimization of the Source Comments to make a Doxygen Documentation file (*.chm) The Headers and Required symbols as example the Headers

  1. include "GameImpl.hpp"
  1. include "../../BaseEntity.hpp"
  2. include "Libs/LookupTables.hpp"
  1. include "ClipSys/CollisionModelMan.hpp"
  1. include "ConsoleCommands/ConsoleInterpreter.hpp"
  1. include "ConsoleCommands/ConVar.hpp"
  1. include "ConsoleCommands/ConFunc.hpp"
  1. include "ConsoleCommands/Console.hpp"
  1. include "FileSys/FileMan.hpp"
  1. include "GuiSys/GuiMan.hpp"
  1. include "MaterialSystem/MaterialManager.hpp"
  1. include "MaterialSystem/Renderer.hpp"
  1. include "MaterialSystem/TextureMap.hpp"
  1. include "TypeSys.hpp"
  1. include "SoundSystem/SoundShaderManager.hpp" for use in the Game. The headers there only used in a Module have low or none priority for the Documentation.

a Example symbol is _ZN14EntFuncLadderT8TypeInfoE there used but not detectable in the Deathmatch Source

Comments (7)

  1. Carsten Fuchs

    Sorry, I don't understand everything in your description above, but essentially you want us to create and upload Cafu API documentation with Doxygen, right? :-)

  2. Oscar Netzahual reporter

    Yes, the essential parts of a usefully API Documentation are the Import Headers of Modules and Essential Pointers and Variables or other thinks like the _ZN14EntFuncLadderT8TypeInfoE (this symbol is not findable in the Source)

    MfG volto

  3. Carsten Fuchs
    • changed status to open

    Ok, thanks!

    Replying to [comment:2 volto]:

    [...] things (sic!) like the _ZN14EntFuncLadderT8TypeInfoE (this symbol is not findable in the Source)

    Well, this is a [http://en.wikipedia.org/wiki/Name_mangling name mangled] symbol. The related symbol in the source code is `EntFuncLadderT::TypeInfo`, found in file `FuncLadder.hpp`.

  4. Carsten Fuchs

    Although it certainly needs more polishing (especially an intro text on the main page, documentation of the remaining namespaces, and fixing all the warnings that Doxygen produces), it's done and available:

    http://api.cafu.de/

    :-)

    (Also see r250.)

  5. Log in to comment