doxygen tweaks

This commit is contained in:
Sebastian Krzyszkowiak 2018-12-16 15:15:38 +01:00
parent 09e6b321b6
commit df1790d242
No known key found for this signature in database
GPG key ID: E8F235CF3BDBC3FF
20 changed files with 2192 additions and 81 deletions

2194
Doxyfile

File diff suppressed because it is too large Load diff

View file

@ -1,6 +1,3 @@
/*! \file character.c
* \brief Character and spritesheet functions.
*/
/*
* Copyright (c) Sebastian Krzyszkowiak <dos@dosowisko.net>
*

View file

@ -1,6 +1,3 @@
/*! \file config.c
* \brief Configuration manager code.
*/
/*
* Copyright (c) Sebastian Krzyszkowiak <dos@dosowisko.net>
*

View file

@ -1,6 +1,3 @@
/*! \file emscripten.c
* \brief Emscripten stub implementations.
*/
/*
* Copyright (c) Sebastian Krzyszkowiak <dos@dosowisko.net>
*
@ -18,6 +15,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/// \privatesection
#include "internal.h"
#undef al_create_audio_stream

View file

@ -1,8 +1,3 @@
/*! \file emscripten.h
* \brief Headers of main file of SuperDerpy engine.
*
* Contains basic functions shared by all views.
*/
/*
* Copyright (c) Sebastian Krzyszkowiak <dos@dosowisko.net>
*
@ -20,11 +15,14 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/// \privatesection
#ifndef LIBSUPERDERPY_EMSCRIPTEN_H
#define LIBSUPERDERPY_EMSCRIPTEN_H
#include "libsuperderpy.h"
/// \private
typedef struct {
ALLEGRO_SAMPLE* sample;
ALLEGRO_SAMPLE_INSTANCE* instance;

View file

@ -1,6 +1,3 @@
/*! \file gamestate.c
* \brief Gamestate management.
*/
/*
* Copyright (c) Sebastian Krzyszkowiak <dos@dosowisko.net>
*

View file

@ -26,6 +26,8 @@
// 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
// 2018-02-06: Inputs: Added mapping for ImGuiKey_Space.
/// \privatesection
#include "imgui/imgui_impl_allegro5.h"
#include <float.h>
#include <stdint.h> // uint64_t

View file

@ -13,6 +13,8 @@
// If you are new to dear imgui, read examples/README.txt and read the documentation at the top of imgui.cpp.
// https://github.com/ocornut/imgui, Original Allegro 5 code by @birthggd
/// \privatesection
#pragma once
#ifdef __cplusplus

View file

@ -16,6 +16,7 @@
*
* Also, ponies.
*/
/// \privatesection
#include "internal.h"
#include "3rdparty/valgrind.h"

View file

@ -14,6 +14,7 @@
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/// \privatesection
#ifndef LIBSUPERDERPY_INTERNAL_H
#define LIBSUPERDERPY_INTERNAL_H
@ -52,6 +53,18 @@
#define SUPPRESS_END
#endif
#ifdef ALLEGRO_WINDOWS
#define LIBRARY_EXTENSION ".dll"
#elif defined(__EMSCRIPTEN__)
#if defined(LIBSUPERDERPY_WASM)
#define LIBRARY_EXTENSION ".wasm"
#else
#define LIBRARY_EXTENSION ".js"
#endif
#else
#define LIBRARY_EXTENSION ".so"
#endif
struct RefCount {
int counter;
char* id;

View file

@ -1,8 +1,3 @@
/*! \file main.c
* \brief Main file of SuperDerpy engine.
*
* Contains basic functions shared by all views.
*/
/*
* Copyright (c) Sebastian Krzyszkowiak <dos@dosowisko.net>
*

View file

@ -185,6 +185,7 @@ struct Game {
} available;
} input;
/// \private
struct {
struct Params params;

View file

@ -1,6 +1,3 @@
/*! \file mainloop.c
* \brief Mainloop handling.
*/
/*
* Copyright (c) Sebastian Krzyszkowiak <dos@dosowisko.net>
*

View file

@ -1,6 +1,3 @@
/*! \file maths.c
* \brief Math helper functions.
*/
/*
* Copyright (c) Sebastian Krzyszkowiak <dos@dosowisko.net>
*

View file

@ -1,6 +1,3 @@
/*! \file particle.c
* \brief Particle engine.
*/
/*
* Copyright (c) Sebastian Krzyszkowiak <dos@dosowisko.net>
*

View file

@ -1,6 +1,3 @@
/*! \file shader.c
* \brief GPU shaders abstraction.
*/
/*
* Copyright (c) Sebastian Krzyszkowiak <dos@dosowisko.net>
*

View file

@ -1,6 +1,3 @@
/*! \file timeline.c
* \brief Timeline Manager framework code.
*/
/*
* Copyright (c) Sebastian Krzyszkowiak <dos@dosowisko.net>
*

View file

@ -1,6 +1,3 @@
/*! \file tween.c
* \brief Tweening engine.
*/
/*
* Copyright (c) Sebastian Krzyszkowiak <dos@dosowisko.net>
*

View file

@ -1,6 +1,3 @@
/*! \file utils.c
* \brief Helper functions.
*/
/*
* Copyright (c) Sebastian Krzyszkowiak <dos@dosowisko.net>
*

View file

@ -23,18 +23,6 @@
#include "libsuperderpy.h"
#ifdef ALLEGRO_WINDOWS
#define LIBRARY_EXTENSION ".dll"
#elif defined(__EMSCRIPTEN__)
#if defined(LIBSUPERDERPY_WASM)
#define LIBRARY_EXTENSION ".wasm"
#else
#define LIBRARY_EXTENSION ".js"
#endif
#else
#define LIBRARY_EXTENSION ".so"
#endif
struct Gamestate;
/*! \brief Draws rectangle filled with vertical gradient. */