Rtch/Lephisto
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Add] Doxygen support.

Browse Source
This commit is contained in:
Allanis 2013-06-11 23:56:43 +01:00
parent 16baff189e
commit edd3f9cd54
2 changed files with 1840 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1828
docs/doxygen/Doxyfile Normal file
View File

File diff suppressed because it is too large Load Diff

17
src/lephisto.c
View File

@ -66,6 +66,10 @@ static void fps_control(void);
static void update_all(void); static void update_all(void);
static void render_all(void); static void render_all(void);
// @brief The entry point of Lephisto.
// @param[in] argc Number of arguments.
// @param[in] argv Array of argc arguments.
#ifdef WIN32 #ifdef WIN32
int WINAPI WinMain(HINSTANCE hInst, HINSTANCE hPrevInst, LPSTR lpCmdLine, int WINAPI WinMain(HINSTANCE hInst, HINSTANCE hPrevInst, LPSTR lpCmdLine,
int nCmdShow) { int nCmdShow) {
@ -223,6 +227,7 @@ void load_all(void) {
space_load(); space_load();
} }
// @brief Unloads all data, simplifies main().
void unload_all(void) { void unload_all(void) {
// Data unloading - order should not matter, but inverse load_all is good. // Data unloading - order should not matter, but inverse load_all is good.
fleet_free(); fleet_free();
@ -234,7 +239,7 @@ void unload_all(void) {
commodity_free(); commodity_free();
} }
// Slip main loop from main() for secondary loop hack in toolkit.c. // @brief Slip main loop from main() for secondary loop hack in toolkit.c.
void main_loop(void) { void main_loop(void) {
sound_update(); // Do sound stuff. sound_update(); // Do sound stuff.
@ -253,9 +258,9 @@ void main_loop(void) {
SDL_GL_SwapBuffers(); SDL_GL_SwapBuffers();
} }
// Updates the game.
static double fps_dt = 1.; static double fps_dt = 1.;
static double dt = 0.; static double dt = 0.;
// @brief Controls the FPS.
static void fps_control(void) { static void fps_control(void) {
// dt in ms/1000. // dt in ms/1000.
dt = (double)(SDL_GetTicks() - gtime) / 1000.; dt = (double)(SDL_GetTicks() - gtime) / 1000.;
@ -271,7 +276,7 @@ static void fps_control(void) {
} }
} }
// Update the game. // @brief Updates the game itself (player flying around etc).
static void update_all(void) { static void update_all(void) {
#if 0 #if 0
if(dt > 1./30.) { if(dt > 1./30.) {
@ -286,7 +291,7 @@ static void update_all(void) {
pilots_update(dt); pilots_update(dt);
} }
// == Renders the game. ================================== // @brief == Renders the game. ===========================
// Blitting order. (layers) // Blitting order. (layers)
// //
// BG | Stars and planets. // BG | Stars and planets.
@ -321,9 +326,9 @@ static void render_all(void) {
} }
// Spit this out on display.
static double fps = 0.; static double fps = 0.;
static double fps_cur = 0.; static double fps_cur = 0.;
// @brief Displays FPS on the screen.
static void display_fps(const double dt) { static void display_fps(const double dt) {
double x, y; double x, y;
fps_dt += dt; fps_dt += dt;
@ -340,6 +345,7 @@ static void display_fps(const double dt) {
gl_print(NULL, x, y, NULL, "%3.2f", fps); gl_print(NULL, x, y, NULL, "%3.2f", fps);
} }
// @brief Set the data module's name.
static void data_name(void) { static void data_name(void) {
uint32_t bufsize; uint32_t bufsize;
char* buf; char* buf;
@ -390,6 +396,7 @@ static void data_name(void) {
xmlCleanupParser(); xmlCleanupParser();
} }
// @brief Set the window caption.
static void window_caption(void) { static void window_caption(void) {
char tmp[DATA_NAME_LEN+10]; char tmp[DATA_NAME_LEN+10];