Skip to content

Commit

Permalink
Some doxygen tweaks, output is still butt-ugly
Browse files Browse the repository at this point in the history
  • Loading branch information
floooh committed Sep 14, 2014
1 parent 8c5ef4b commit a10ebb1
Show file tree
Hide file tree
Showing 10 changed files with 33 additions and 17 deletions.
5 changes: 3 additions & 2 deletions code/Modules/Core/Core.h
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
#pragma once
//------------------------------------------------------------------------------
/**
@defgroup Core Core
@brief Core module
@class Oryol::Core
@ingroup Core
@brief Core module facade
@todo: Core description
*/
#include "Core/RefCounted.h"
#include "Core/Singleton.h"
Expand Down
7 changes: 5 additions & 2 deletions code/Modules/Dbg/Dbg.h
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
#pragma once
//------------------------------------------------------------------------------
/**
@defgroup Dbg Dbg
@brief debug visualization and services
@class Oryol::Dbg
@ingroup Debug
@brief various runtime debugging and debug visualization services
@ingroup Dbg
@brief Dbg module facade
*/
#include "Core/Config.h"
#include "Core/Singleton.h"
Expand Down
2 changes: 1 addition & 1 deletion code/Modules/IO/Core/IOConfig.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once
//------------------------------------------------------------------------------
/**
@file IO/Config.h
@file IOConfig.h
@ingroup IO
@brief Configuration defines for the Oryol IO module.
*/
Expand Down
3 changes: 3 additions & 0 deletions code/Modules/IO/IO.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
#pragma once
//------------------------------------------------------------------------------
/**
@defgroup IO IO
@brief IO module
@class Oryol::IO
@ingroup IO
@brief IO module facade
Expand Down
1 change: 1 addition & 0 deletions code/Modules/Input/Core/CursorMode.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ namespace Oryol {

class CursorMode {
public:
/// mouse cursor modes
enum Code {
Normal = 0, ///< cursor visible, mouse pos clamped by screen border
Hidden, ///< cursor invisible, mouse pos clamped by screen border
Expand Down
7 changes: 5 additions & 2 deletions code/Modules/Input/Input.h
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
#pragma once
//------------------------------------------------------------------------------
/**
@defgroup Input Input
@brief getting input
@class Oryol::Input
@ingroup Input
@brief Oryol Input module facade
@brief Input module facade
Provides access to connected input devices,
like keyboard, mouse and game pads. On mobile platforms it also allows
to query touch gestures.
Expand Down
6 changes: 4 additions & 2 deletions code/Modules/NanoVG/NanoVG.h
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
#pragma once
//------------------------------------------------------------------------------
/**
@defgroup NanoVG NanoVG
@brief nanovg wrapper module
@class Oryol::NanoVG
@ingroup NanoVG
@brief nanovg initialization and resource management wrapper
@brief NanoVG module facade
*/
#include "Core/Types.h"
#include "Core/Singleton.h"
Expand All @@ -19,7 +22,6 @@
struct NVGcontext;

namespace Oryol {

class NanoVG {
public:
/// setup the NanoVG module
Expand Down
7 changes: 4 additions & 3 deletions code/Modules/Render/Render.h
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
#pragma once
//------------------------------------------------------------------------------
/**
@defgroup Render Render
@brief 3D rendering
@class Oryol::Render
@ingroup Render
@brief public facade of the Render module
@todo: describe Render module
@brief Render module facade
*/
#include "Core/Singleton.h"
#include "Render/Core/displayMgr.h"
Expand Down
5 changes: 4 additions & 1 deletion code/Modules/Synth/Synth.h
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
#pragma once
//------------------------------------------------------------------------------
/**
@defgroup Synth Synth
@brief chip-tune audio synthesis
@class Oryol::Synth
@ingroup Synth
@brief the Synth module implements a chip-tune audio system
@brief Synth module facade
*/
#include "Core/Singleton.h"
#include "Synth/Core/soundMgr.h"
Expand Down
7 changes: 3 additions & 4 deletions doc/doxygen.conf
Original file line number Diff line number Diff line change
Expand Up @@ -754,8 +754,7 @@ WARN_LOGFILE =
# spaces.
# Note: If this tag is empty the current directory is searched.

INPUT = ../code/Core \
../code/Modules
INPUT = ../code/Modules

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down Expand Up @@ -1112,7 +1111,7 @@ HTML_COLORSTYLE_HUE = 220
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_COLORSTYLE_SAT = 100
HTML_COLORSTYLE_SAT = 200

# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
Expand All @@ -1123,7 +1122,7 @@ HTML_COLORSTYLE_SAT = 100
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_COLORSTYLE_GAMMA = 80
HTML_COLORSTYLE_GAMMA = 100

# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting this
Expand Down

0 comments on commit a10ebb1

Please sign in to comment.