doxygen comments and config file

[xonotic/darkplaces.git] / console.h

diff --git a/console.h b/console.h
index 74e44839466899722a7263ac79dc51bb9497c3d0..10009bf145008edeebb529447147ff094795991e 100644 (file)
--- a/console.h
+++ b/console.h
@@ -32,42 +32,54 @@ void Con_Rcon_Redirect_Init(lhnetsocket_t *sock, lhnetaddress_t *dest);
 void Con_Rcon_Redirect_End();
 void Con_Rcon_Redirect_Abort();
 
+/// If the line width has changed, reformat the buffer.
 void Con_CheckResize (void);
 void Con_Init (void);
 void Con_Init_Commands (void);
 void Con_Shutdown (void);
 void Con_DrawConsole (int lines);
+
+/// Prints to all appropriate console targets, and adds timestamps
 void Con_Print(const char *txt);
+
+/// Prints to all appropriate console targets.
 void Con_Printf(const char *fmt, ...) DP_FUNC_PRINTF(1);
+
+/// A Con_Print that only shows up if the "developer" cvar is set.
 void Con_DPrint(const char *msg);
+
+/// A Con_Printf that only shows up if the "developer" cvar is set
 void Con_DPrintf(const char *fmt, ...) DP_FUNC_PRINTF(1);
 void Con_Clear_f (void);
 void Con_DrawNotify (void);
+
+/// Clear all notify lines.
 void Con_ClearNotify (void);
 void Con_ToggleConsole_f (void);
 
 qboolean GetMapList (const char *s, char *completedname, int completednamebufferlength);
 
-// wrapper function to attempt to either complete the command line
-// or to list possible matches grouped by type
-// (i.e. will display possible variables, aliases, commands
-// that match what they've typed so far)
+/// wrapper function to attempt to either complete the command line
+/// or to list possible matches grouped by type
+/// (i.e. will display possible variables, aliases, commands
+/// that match what they've typed so far)
 void Con_CompleteCommandLine(void);
 
-// Generic libs/util/console.c function to display a list
-// formatted in columns on the console
+/// Generic libs/util/console.c function to display a list
+/// formatted in columns on the console
 void Con_DisplayList(const char **list);
 
 
-//
-// log
-//
+/*! \name log
+ * @{
+ */
 void Log_Init (void);
 void Log_Close (void);
 void Log_Start (void);
-void Log_DestBuffer_Flush (void); // call this once per frame to send out replies to rcon streaming clients
+void Log_DestBuffer_Flush (void); ///< call this once per frame to send out replies to rcon streaming clients
 
 void Log_Printf(const char *logfilename, const char *fmt, ...) DP_FUNC_PRINTF(2);
+//@}
 
 #define CON_MASK_HIDENOTIFY 128
 #define CON_MASK_CHAT 1
@@ -79,9 +91,9 @@ typedef struct con_lineinfo_s
        size_t len;
        int mask;
 
-       // used only by console.c
+       /// used only by console.c
        double addtime;
-       int height; // recalculated line height when needed (-1 to unset)
+       int height; ///< recalculated line height when needed (-1 to unset)
 }
 con_lineinfo_t;
 
@@ -92,7 +104,7 @@ typedef struct conbuffer_s
        int maxlines;
        con_lineinfo_t *lines;
        int lines_first;
-       int lines_count; // cyclic buffer
+       int lines_count; ///< cyclic buffer
 }
 conbuffer_t;
 
@@ -103,9 +115,20 @@ conbuffer_t;
 void ConBuffer_Init(conbuffer_t *buf, int textsize, int maxlines, mempool_t *mempool);
 void ConBuffer_Clear (conbuffer_t *buf);
 void ConBuffer_Shutdown(conbuffer_t *buf);
+
+/*! Notifies the console code about the current time
+ * (and shifts back times of other entries when the time
+ * went backwards)
+ */
 void ConBuffer_FixTimes(conbuffer_t *buf);
+
+/// Deletes the first line from the console history.
 void ConBuffer_DeleteLine(conbuffer_t *buf);
+
+/// Deletes the last line from the console history.
 void ConBuffer_DeleteLastLine(conbuffer_t *buf);
+
+/// Appends a given string as a new line to the console.
 void ConBuffer_AddLine(conbuffer_t *buf, const char *line, int len, int mask);
 int ConBuffer_FindPrevLine(conbuffer_t *buf, int mask_must, int mask_mustnot, int start);
 int ConBuffer_FindNextLine(conbuffer_t *buf, int mask_must, int mask_mustnot, int start);