Skip to content

Commit

Permalink
fix all the Doxygen warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
fmang committed Mar 27, 2020
1 parent b4becdf commit 33bb85e
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 14 deletions.
10 changes: 4 additions & 6 deletions include/core/log.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@
* It is a bit more verbose but it is also easier to extend, and also
* type-safe.
*
* See #oshu::log.
*
* \{
*/

Expand Down Expand Up @@ -119,14 +117,14 @@ extern log_level log_priority;
/**
* Return the output stream for the wanted verbosity.
*
* If the level is greater than or equal to #priority, return a handle to
* If the level is greater than or equal to #log_priority, return a handle to
* std::clog, otherwise return a dummy stream.
*
* It is your responsibility to write std::endl at the end of your log message.
*
* You should use #critical, #error, #warning, #info, #debug or #verbose to
* access your logger than this function directly, as they prefix your message
* with the log level.
* You should use #critical_log, #error_log, #warning_log, #info_log, #debug_log
* or #verbose_log to access your logger than this function directly, as they
* prefix your message with the log level.
*
* \todo
* Support redirecting to a standard file, probably by redirecting std::clog.
Expand Down
6 changes: 2 additions & 4 deletions include/game/base.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* \file game/game.h
* \file game/base.h
* \ingroup game
*
* Define the game module.
Expand Down Expand Up @@ -30,8 +30,6 @@ class game_base : public game_mode {
* After creating the game, you're free to toy with the options of the game,
* especially autoplay and pause.
*
* When you're done settings the game up, call #oshu_run_game.
*
* \todo
* It should not be the responsibility of this module to load the beatmap. If
* the beatmap is a taiko beatmap, then the taiko game should be instanciated,
Expand Down Expand Up @@ -59,7 +57,7 @@ class game_base : public game_mode {
*/
void rewind(double offset);
/**
* See #oshu_rewind_game.
* See #rewind.
*/
void forward(double offset);
/**
Expand Down
2 changes: 1 addition & 1 deletion include/game/mode.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ struct game_mode {
*
* There's no guarantee this callback is called at regular intervals.
*
* For autoplay, use #autoplay instead.
* For autoplay, use #check_autoplay instead.
*/
virtual int check() = 0;

Expand Down
2 changes: 1 addition & 1 deletion include/game/osu.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ struct osu_game : public oshu::game_base {
* When the #current_slider is NULL, the value of this field is
* irrelevant.
*/
enum oshu_finger held_key {};
enum oshu_finger held_key = {};
std::shared_ptr<oshu::mouse> mouse {};

int check() override;
Expand Down
2 changes: 1 addition & 1 deletion include/library/html.h
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ namespace oshu {
* ```
*
* The string object is taken by reference, so it must not be modified or
* deleted as long as the #escape object is still alive.
* deleted as long as the #html_escape object is still alive.
*/
class html_escape {
public:
Expand Down
2 changes: 1 addition & 1 deletion lib/game/base.cc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* \file game/game.cc
* \file game/base.cc
* \ingroup game
*
* Implemention game initialization, destruction and the main loop.
Expand Down

0 comments on commit 33bb85e

Please sign in to comment.