From 70157eedabb896ff9a54a492813e093eeb8aa1f6 Mon Sep 17 00:00:00 2001 From: Ash Date: Wed, 25 Jul 2018 10:37:54 +1000 Subject: [PATCH 1/3] docs: Add JAVADOC_AUTOBRIEF option to CMakeLists --- docs/CMakeLists.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 2e767fce..60662f76 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -29,6 +29,7 @@ if(DOXYGEN_FOUND) "WUT_UNKNOWN_BYTES" "WUT_UNKNOWN_SIZE") set(DOXYGEN_SOURCE_BROWSER YES) + set(DOXYGEN_JAVADOC_AUTOBRIEF YES) set(DOXYGEN_ENUM_VALUES_PER_LINE 1) set(DOXYGEN_CLASS_DIAGRAMS NO) set(DOXYGEN_COLLABORATION_GRAPH NO) From 33ae7587d6744b9ec544cc28540c9944a98e5ef1 Mon Sep 17 00:00:00 2001 From: Ash Date: Wed, 25 Jul 2018 10:38:31 +1000 Subject: [PATCH 2/3] include/coreinit: Shorten/rephrase some particularly long briefs --- include/coreinit/filesystem.h | 2 ++ include/coreinit/thread.h | 2 ++ 2 files changed, 4 insertions(+) diff --git a/include/coreinit/filesystem.h b/include/coreinit/filesystem.h index 175473cc..d2850db1 100644 --- a/include/coreinit/filesystem.h +++ b/include/coreinit/filesystem.h @@ -6,6 +6,8 @@ * \defgroup coreinit_fs Filesystem * \ingroup coreinit * + * Mount, access and modify filesystems directly. + * * First call FSInit to initialise the file system library, then call * FSAddClient to initialise your FSClient structure, then you need to use * FSInitCmdBlock to initialise an FSCmdBlock structure for each command you diff --git a/include/coreinit/thread.h b/include/coreinit/thread.h index 0f430983..fcd5db72 100644 --- a/include/coreinit/thread.h +++ b/include/coreinit/thread.h @@ -8,6 +8,8 @@ * \defgroup coreinit_thread Thread * \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 * to the usual pre-emptive scheduling that most operating systems use (such as * Windows, Linux, etc). In co-operative scheduling threads must voluntarily yield From c9b2013b729e966ab9437560ec2e226a0e29e6de Mon Sep 17 00:00:00 2001 From: Ash Date: Wed, 25 Jul 2018 10:45:06 +1000 Subject: [PATCH 3/3] include/coreinit: Fix up some more Doxygen briefs --- include/coreinit/cache.h | 6 +++--- include/coreinit/core.h | 3 +-- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/include/coreinit/cache.h b/include/coreinit/cache.h index f20a9ed2..5161296d 100644 --- a/include/coreinit/cache.h +++ b/include/coreinit/cache.h @@ -5,10 +5,10 @@ * \defgroup coreinit_cache Cache * \ingroup coreinit * - * The Cache group of functions provide an interface to the low-level caching - * system of the PowerPC processor. The cache acts as a middleman between main - * memory and the processor, speeding up access to frequently-used data. + * Interface to the low-level caching system of the PowerPC processor. * + * 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 * 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 diff --git a/include/coreinit/core.h b/include/coreinit/core.h index a34e6771..faa6dc5a 100644 --- a/include/coreinit/core.h +++ b/include/coreinit/core.h @@ -5,8 +5,7 @@ * \defgroup coreinit_core Core * \ingroup coreinit * - * The coreinit Core group of functions provide information about each core of - * the system's processor. + * Provides information about each core of the system's processor. * @{ */