Add documentation to rmode

CHANGELOG.md

@@ -1,4 +1,5 @@
 # Change Log
+
 All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
@@ -106,7 +107,7 @@ All notable changes to this project will be documented in this file.
 - New Bitmap FX
 - Add `GRRLIB_Exit()` to free the memory allocated by GRRLIB
 
-[Unreleased]: https://github.com/GRRLIB/GRRLIB/compare/v4.4.0...HEAD
+[unreleased]: https://github.com/GRRLIB/GRRLIB/compare/v4.4.0...HEAD
 [4.4.0]: https://github.com/GRRLIB/GRRLIB/compare/4.3.2...v4.4.0
 [4.3.2]: https://github.com/GRRLIB/GRRLIB/compare/4.3.1...4.3.2
 [4.3.1]: https://github.com/GRRLIB/GRRLIB/compare/4.3.0...4.3.1

GRRLIB/GRRLIB/GRRLIB_core.c

@@ -1,5 +1,5 @@
 /*------------------------------------------------------------------------------
-Copyright (c) 2009-2019 The GRRLIB Team
+Copyright (c) 2009-2020 The GRRLIB Team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -55,14 +55,18 @@ int  GRRLIB_Init (void) {
     s8 error_code = 0;
 
     // Ensure this function is only ever called once
-    if (is_setup)  return 0;
+    if (is_setup == true) {
+        return 0;
+    }
 
     // Initialise the video subsystem
     VIDEO_Init();
     VIDEO_SetBlack(true);  // Disable video output during initialisation
 
     // Grab a pointer to the video mode attributes
-    if ( !(rmode = VIDEO_GetPreferredMode(NULL)) )  return -1;
+    if ( !(rmode = VIDEO_GetPreferredMode(NULL)) ) {
+        return -1;
+    }
 
     // Video Mode Correction
     switch (rmode->viTVMode) {

GRRLIB/GRRLIB/grrlib.h

@@ -173,7 +173,7 @@ typedef  struct GRRLIB_Font {
 # define GRR_INITS(...)
 #endif
 
-GRR_EXTERN  GXRModeObj  *rmode;
+GRR_EXTERN  GXRModeObj  *rmode; /**< Video mode. */
 GRR_EXTERN  void        *xfb[2]  GRR_INITS(NULL, NULL);
 GRR_EXTERN  u32         fb       GRR_INIT(0);
 //==============================================================================

grrlib.doxygen

@@ -844,7 +844,8 @@ INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.c \
                          *.cpp \
                          *.h \
-                         *.md
+                         *.md \
+                         *.dox
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.
@@ -2249,7 +2250,7 @@ HIDE_UNDOC_RELATIONS   = YES
 # set to NO
 # The default value is: NO.
 
-HAVE_DOT               = NO
+HAVE_DOT               = YES
 
 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
 # to run in parallel. When set to 0 doxygen will base this on the number of