Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added reference to module loading in doc. #273

Merged
merged 2 commits into from
Jan 1, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -241,9 +241,11 @@ TAB_SIZE = 4
ALIASES = projectstart="---------------------\n### Using this library in your project ###\n"
ALIASES += projectinc{1}="Include the header file in your project:\n\code #include <\1> \endcode\n"
ALIASES += projectlib{1}="Link the library to the executable:\n\code \1 \endcode \n"
ALIASES += projectmod{1}="Load the required module:\n\code sceSysmoduleLoadModule(\1); \endcode \n"
ALIASES += projectend="---------------------\n"
ALIASES += usage{1}="\projectstart \projectinc{\1} \projectend"
ALIASES += usage{2}="\projectstart \projectinc{\1} \projectlib{\2} \projectend"
ALIASES += usage{3}="\projectstart \projectinc{\1} \projectlib{\2} \projectmod{\3} \projectend"
ALIASES += usergroup{1}="\defgroup \1User User\n \ingroup \1\n Exports for User\n\\{\n"
ALIASES += kernelgroup{1}="\defgroup \1Kernel Kernel\n \ingroup \1\n Exports for Kernel\n\\{\n"

Expand Down
2 changes: 1 addition & 1 deletion include/psp2/apputil.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* \usergroup{SceAppUtil}
* \usage{psp2/apputil.h,SceAppUtil_stub}
* \usage{psp2/apputil.h,SceAppUtil_stub,SCE_SYSMODULE_APPUTIL}
*/


Expand Down
2 changes: 1 addition & 1 deletion include/psp2/atrac.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* \usergroup{SceAtrac}
* \usage{psp2/atrac.h,SceAtrac_stub}
* \usage{psp2/atrac.h,SceAtrac_stub,SCE_SYSMODULE_ATRAC}
*/


Expand Down
2 changes: 1 addition & 1 deletion include/psp2/fiber.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* \usergroup{SceFiber}
* \usage{psp2/fiber.h,SceFiber_stub}
* \usage{psp2/fiber.h,SceFiber_stub,SCE_SYSMODULE_FIBER}
*/


Expand Down
2 changes: 1 addition & 1 deletion include/psp2/ime_dialog.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* \usergroup{SceIme}
* \usage{psp2/ime_dialog.h,SceIme_stub}
* \usage{psp2/ime_dialog.h,SceIme_stub,SCE_SYSMODULE_IME}
*/


Expand Down
2 changes: 1 addition & 1 deletion include/psp2/location.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* \usergroup{SceLocation}
* \usage{psp2/location.h,SceLibLocation_stub}
* \usage{psp2/location.h,SceLibLocation_stub,SCE_SYSMODULE_LOCATION}
*/


Expand Down
14 changes: 13 additions & 1 deletion include/psp2/net/http.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* \usergroup{SceHttp}
* \usage{psp2/net/http.h,SceHttp_stub}
* \usage{psp2/net/http.h,SceHttp_stub,SCE_SYSMODULE_HTTP}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a warning about loading SCE_SYSMODULE_HTTPS on the function sceHttpsLoadCert().

*/


Expand Down Expand Up @@ -335,6 +335,18 @@ int sceHttpUriMerge(char *mergedUrl, const char *url, const char *relativeUrl, u
int sceHttpUriSweepPath(char *dst, const char *src , unsigned int srcSize);

// https
/**
* Register RootCA certificate for HTTPS authentication
*
* @param[in] caCertNum - Number of elements of the list referncing to RootCA certificate
* @param[in] caList - List referencing to RootCA certificate
* @param[in] cert - Client certificate
* @param[in] privKey - Private key
*
* @return 0 on success, < 0 on error.
*
* @note <b>SCE_SYSMODULE_HTTPS</b> module must be loaded with ::sceSysmoduleLoadModule to use this function.
*/
int sceHttpsLoadCert(int caCertNum, const SceHttpsData **caList, const SceHttpsData *cert, const SceHttpsData *privKey);
int sceHttpsUnloadCert(void);
int sceHttpsEnableOption(unsigned int sslFlags);
Expand Down
2 changes: 1 addition & 1 deletion include/psp2/net/net.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* \usergroup{SceNet}
* \usage{psp2/net/net.h,SceNet_stub}
* \usage{psp2/net/net.h,SceNet_stub,SCE_SYSMODULE_NET}
*/


Expand Down
2 changes: 1 addition & 1 deletion include/psp2/pgf.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* \usergroup{ScePgf}
* \usage{psp2/pgf.h,ScePgf_stub}
* \usage{psp2/pgf.h,ScePgf_stub,SCE_SYSMODULE_PGF}
*/


Expand Down
2 changes: 1 addition & 1 deletion include/psp2/shutter_sound.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* \usergroup{SceShutterSound}
* \usage{psp2/shutter_sound.h,SceShutterSound_stub}
* \usage{psp2/shutter_sound.h,SceShutterSound_stub,SCE_SYSMODULE_SHUTTER_SOUND}
*/


Expand Down
2 changes: 1 addition & 1 deletion include/psp2/sqlite.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* \usergroup{SceSqlite}
* \usage{psp2/sqlite.h,SceSqlite_stub}
* \usage{psp2/sqlite.h,SceSqlite_stub,SCE_SYSMODULE_SQLITE}
*/


Expand Down
2 changes: 1 addition & 1 deletion include/psp2/videodec.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* \usergroup{SceVideoDec}
* \usage{psp2/videodec.h,SceVideodec_stub}
* \usage{psp2/videodec.h,SceVideodec_stub,SCE_SYSMODULE_AVCDEC}
*/


Expand Down