The-Homebrew-Cloud/wut
2
0
Fork 0
mirror of https://github.com/wiiu-env/wut.git synced 2025-01-07 15:28:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #83 from QuarkTheAwesome/master

Browse Source 
COS Docs: Enable JAVADOC_AUTOBRIEF
This commit is contained in:
James 2018-07-26 00:26:44 -07:00 committed by GitHub
commit 4ff6c40f2c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/CMakeLists.txt
View File

@ -29,6 +29,7 @@ if(DOXYGEN_FOUND)
"WUT_UNKNOWN_BYTES" "WUT_UNKNOWN_BYTES"
"WUT_UNKNOWN_SIZE") "WUT_UNKNOWN_SIZE")
set(DOXYGEN_SOURCE_BROWSER YES) set(DOXYGEN_SOURCE_BROWSER YES)
set(DOXYGEN_JAVADOC_AUTOBRIEF YES)
set(DOXYGEN_ENUM_VALUES_PER_LINE 1) set(DOXYGEN_ENUM_VALUES_PER_LINE 1)
set(DOXYGEN_CLASS_DIAGRAMS NO) set(DOXYGEN_CLASS_DIAGRAMS NO)
set(DOXYGEN_COLLABORATION_GRAPH NO) set(DOXYGEN_COLLABORATION_GRAPH NO)

6
include/coreinit/cache.h
View File

@ -5,10 +5,10 @@
* \defgroup coreinit_cache Cache * \defgroup coreinit_cache Cache
* \ingroup coreinit * \ingroup coreinit
* *
* The Cache group of functions provide an interface to the low-level caching * Interface to the low-level caching system of the PowerPC processor.
* system of the PowerPC processor. The cache acts as a middleman between main
* memory and the processor, speeding up access to frequently-used data.
* *
* The cache acts as a middleman between main
* memory and the processor, speeding up access to frequently-used data.
* However, the Wii U is not cache-coherent - written data may be cached * However, the Wii U is not cache-coherent - written data may be cached
* without updating main memory, and data read from the cache may be out of date * without updating main memory, and data read from the cache may be out of date
* with respect to memory. While this isn't a problem for most code, certain * with respect to memory. While this isn't a problem for most code, certain

3
include/coreinit/core.h
View File

@ -5,8 +5,7 @@
* \defgroup coreinit_core Core * \defgroup coreinit_core Core
* \ingroup coreinit * \ingroup coreinit
* *
* The coreinit Core group of functions provide information about each core of * Provides information about each core of the system's processor.
* the system's processor.
* @{ * @{
*/ */

2
include/coreinit/filesystem.h
View File

@ -6,6 +6,8 @@
* \defgroup coreinit_fs Filesystem * \defgroup coreinit_fs Filesystem
* \ingroup coreinit * \ingroup coreinit
* *
* Mount, access and modify filesystems directly.
*
* First call FSInit to initialise the file system library, then call * First call FSInit to initialise the file system library, then call
* FSAddClient to initialise your FSClient structure, then you need to use * FSAddClient to initialise your FSClient structure, then you need to use
* FSInitCmdBlock to initialise an FSCmdBlock structure for each command you * FSInitCmdBlock to initialise an FSCmdBlock structure for each command you

2
include/coreinit/thread.h
View File

@ -8,6 +8,8 @@
* \defgroup coreinit_thread Thread * \defgroup coreinit_thread Thread
* \ingroup coreinit * \ingroup coreinit
* *
* Manage and run threads on each of the system's cores.
*
* The thread scheduler in the Wii U uses co-operative scheduling, this is different * The thread scheduler in the Wii U uses co-operative scheduling, this is different
* to the usual pre-emptive scheduling that most operating systems use (such as * to the usual pre-emptive scheduling that most operating systems use (such as
* Windows, Linux, etc). In co-operative scheduling threads must voluntarily yield * Windows, Linux, etc). In co-operative scheduling threads must voluntarily yield