Skip to content

Commit

Permalink
Merge pull request #3 from uppfinnarn/master
Browse files Browse the repository at this point in the history
Fixed up Doxygen stuff
  • Loading branch information
dogo committed Apr 10, 2014
2 parents 3f3bfe6 + 3a81548 commit fe2f5be
Show file tree
Hide file tree
Showing 13 changed files with 2,143 additions and 50 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
*.o
.DS_Store

OSLib_MOD2_Documentation/

2,134 changes: 2,105 additions & 29 deletions Doxyfile

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions VirtualFile.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion adhoc/pspadhoc.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

#define MAX_REMOTEPSP 100

/** @defgroup adhoc
/** @defgroup AdHoc AdHoc
Functions for adhoc.
@{
Expand Down
14 changes: 12 additions & 2 deletions browser.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
extern "C" {
#endif

/** @defgroup Browser
/** @defgroup Browser Browser
Functions to display Sony's internet browser
@{
Expand All @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion dialog.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#ifndef DIALOG_H
#define DIALOG_H

/** @defgroup Dialogs
/** @defgroup Dialogs Dialogs
Functions to display Sony's dialogs
@{
Expand Down
4 changes: 3 additions & 1 deletion drawing.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ extern "C" {
@{
*/

/** \ingroup drawing_color True color. */
/** \ingroup drawing_color True color */
typedef unsigned long OSL_COLOR;


Expand Down Expand Up @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions net.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

#include <sys/fd_set.h>

/** @defgroup Network
/** @defgroup Network Network
Network functions
@{
Expand Down Expand Up @@ -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));
Expand Down
2 changes: 1 addition & 1 deletion osk.h
Original file line number Diff line number Diff line change
@@ -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
@{
Expand Down
6 changes: 3 additions & 3 deletions oslib.h
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
8 changes: 4 additions & 4 deletions saveload.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion sfont.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
extern "C" {
#endif

/** @defgroup SFont
/** @defgroup SFont SFont
Functions to manage SFonts
@{
Expand Down
6 changes: 3 additions & 3 deletions text.h
Original file line number Diff line number Diff line change
Expand Up @@ -236,17 +236,17 @@ 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
*
* @param y - Y position on screen
*
* @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
*/
Expand Down

0 comments on commit fe2f5be

Please sign in to comment.