From 3a8154817cc1944959cec6d1a79a5cafe4ef51fb Mon Sep 17 00:00:00 2001 From: Johannes Ekberg Date: Fri, 7 Feb 2014 23:22:18 +0100 Subject: [PATCH] No more Doxygen warnings --- VirtualFile.h | 2 ++ adhoc/pspadhoc.h | 2 +- browser.h | 14 ++++++++++++-- dialog.h | 2 +- drawing.h | 4 +++- net.h | 8 ++++---- osk.h | 2 +- oslib.h | 6 +++--- saveload.h | 8 ++++---- sfont.h | 2 +- text.h | 6 +++--- 11 files changed, 35 insertions(+), 21 deletions(-) diff --git a/VirtualFile.h b/VirtualFile.h index fee4365..205392d 100644 --- a/VirtualFile.h +++ b/VirtualFile.h @@ -133,6 +133,8 @@ void VirtualFileInit(); /** Open a new file. \param param1 Pointer to a string representing the file name. + \param param2 + Should always be 0 \param type File type. By default, can be: - VF_MEMORY: read/write from a memory block diff --git a/adhoc/pspadhoc.h b/adhoc/pspadhoc.h index ccc581a..9923eec 100644 --- a/adhoc/pspadhoc.h +++ b/adhoc/pspadhoc.h @@ -28,7 +28,7 @@ #define MAX_REMOTEPSP 100 -/** @defgroup adhoc +/** @defgroup AdHoc AdHoc Functions for adhoc. @{ diff --git a/browser.h b/browser.h index 90f6bf2..32374f1 100755 --- a/browser.h +++ b/browser.h @@ -5,7 +5,7 @@ extern "C" { #endif -/** @defgroup Browser +/** @defgroup Browser Browser Functions to display Sony's internet browser @{ @@ -20,7 +20,17 @@ extern "C" { \param url The url to open \param downloadDir - The default + The default download directory + \param browserMemory + The amount of memory to allocate for the browser + \param displaymode + One of pspUtilityHtmlViewerDisplayModes + \param options + One of pspUtilityHtmlViewerOptions + \param interfacemode + One of pspUtilityHtmlViewerInterfaceModes + \param connectmode + One of pspUtilityHtmlViewerConnectModes */ int oslBrowserInit(char *url, char *downloadDir, int browserMemory, unsigned int displaymode, unsigned int options, unsigned int interfacemode, unsigned int connectmode); diff --git a/dialog.h b/dialog.h index 9f3342c..1f34345 100644 --- a/dialog.h +++ b/dialog.h @@ -1,7 +1,7 @@ #ifndef DIALOG_H #define DIALOG_H -/** @defgroup Dialogs +/** @defgroup Dialogs Dialogs Functions to display Sony's dialogs @{ diff --git a/drawing.h b/drawing.h index 4ab19b6..38ddaea 100644 --- a/drawing.h +++ b/drawing.h @@ -27,7 +27,7 @@ extern "C" { @{ */ -/** \ingroup drawing_color True color. */ +/** \ingroup drawing_color True color */ typedef unsigned long OSL_COLOR; @@ -1368,6 +1368,8 @@ enum OSL_TEXWRAP_MODES { /** Defines the current texture, useful for low level image drawing. */ extern void oslSetTexture(OSL_IMAGE *img); /** Same but also defines the beginning coordinate in the texture. Useful for tricks meant to display an image bigger than 512x512. + \param img + Texture to set \param x, y Beginning (top-left corner) of the image. Should be a multiple of 512. The (x, y) corner will become the (u, v) = (0, 0) coordinate when drawing a texture, and a 512x512 range (to the right and down) will be accessible. diff --git a/net.h b/net.h index 65236c8..cf6fbb0 100755 --- a/net.h +++ b/net.h @@ -3,7 +3,7 @@ #include -/** @defgroup Network +/** @defgroup Network Network Network functions @{ @@ -93,11 +93,11 @@ int oslNetTerm(); int oslGetIPaddress(char *IPaddress); /**Tries to connect to an Access Point using the given configuration - \param int config + \param config Index of the configuration to use - \param int timeout + \param timeout Timeout (in seconds) for the connection - \param int (*apctlCallback)(int state) + \param *apctlCallback Pointer to a callback function. It will be called with the current state */ int oslConnectToAP(int config, int timeout, int (*apctlCallback)(int state)); diff --git a/osk.h b/osk.h index bf2ba99..7c89f17 100644 --- a/osk.h +++ b/osk.h @@ -1,7 +1,7 @@ #ifndef OSK_H #define OSK_H -/** @defgroup OSK +/** @defgroup OSK On-Screen Keyboard Functions to display Sony's On Screen Keyboard @{ diff --git a/oslib.h b/oslib.h index 4c66e52..0fe4600 100644 --- a/oslib.h +++ b/oslib.h @@ -293,12 +293,12 @@ debug. */ #endif /** Allocates a memory block, ensuring it is aligned. - \param 1 + \param alignment Alignment in bytes - \param 2 + \param size Size of the block */ -void *memalign(size_t, size_t); +void *memalign(size_t alignment, size_t size); /** Structure for the return value of oslGetRamStatus. */ typedef struct { diff --git a/saveload.h b/saveload.h index b37cfc9..0fdbb7a 100644 --- a/saveload.h +++ b/saveload.h @@ -86,23 +86,23 @@ void oslInitSingleSaveDialog(struct oslSaveLoad *saveData); */ void oslInitAutoSaveDialog(struct oslSaveLoad *saveData); /**Initializes the load dialog - \param *saveData + \param *loadData Pointer to a oslSaveLoad structure where data will be loaded */ void oslInitLoadDialog(struct oslSaveLoad *loadData); /**Initializes the multilist load dialog - \param *saveData + \param *loadData Pointer to a oslSaveLoad structure where data will be loaded */ void oslInitMultiLoadDialog(struct oslSaveLoad *loadData); /**Initializes the single load dialog - \param *saveData + \param *loadData Pointer to a oslSaveLoad structure where data will be loaded */ void oslInitSingleLoadDialog(struct oslSaveLoad *loadData); /**Initializes the automatic load dialog - \param *saveData + \param *loadData Pointer to a oslSaveLoad structure where data will be loaded */ void oslInitAutoLoadDialog(struct oslSaveLoad *loadData); diff --git a/sfont.h b/sfont.h index ce04800..595b1e0 100644 --- a/sfont.h +++ b/sfont.h @@ -5,7 +5,7 @@ extern "C" { #endif -/** @defgroup SFont +/** @defgroup SFont SFont Functions to manage SFonts @{ diff --git a/text.h b/text.h index 3ccd79f..5baee62 100644 --- a/text.h +++ b/text.h @@ -236,7 +236,7 @@ extern void oslIntraFontSetStyle(OSL_FONT *f, float size, unsigned int color, un /** * Draw text along the baseline starting at x, y. * - * @param font - A valid ::intraFont + * @param f - A valid ::OSL_FONT with type ::OSL_FONT_INTRA * * @param x - X position on screen * @@ -244,9 +244,9 @@ extern void oslIntraFontSetStyle(OSL_FONT *f, float size, unsigned int color, un * * @param width - column width for automatic line breaking (intraFontPrintColumn... versions only) * - * @param text - Text to draw (ASCII & extended ASCII, S-JIS or UTF-8 encoded) + * @param autoBreakLine - char length of text to draw (...Ex versions only) * - * @param length - char length of text to draw (...Ex versions only) + * @param text - Text to draw (ASCII & extended ASCII, S-JIS or UTF-8 encoded) * * @returns The x position after the last char */