Documentation work

This commit is contained in:
pjht 2020-07-25 18:01:05 -05:00
parent b83a5505c3
commit 9ab1f97e08
4 changed files with 38 additions and 2585 deletions

View File

@ -789,7 +789,7 @@ WARN_IF_DOC_ERROR = YES
# EXTRACT_ALL is set to YES then this flag will automatically be disabled. # EXTRACT_ALL is set to YES then this flag will automatically be disabled.
# The default value is: NO. # The default value is: NO.
WARN_NO_PARAMDOC = NO WARN_NO_PARAMDOC = YES
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered. # a warning is encountered.
@ -1108,6 +1108,35 @@ USE_HTAGS = NO
VERBATIM_HEADERS = YES VERBATIM_HEADERS = YES
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
# cost of reduced performance. This can be particularly helpful with template
# rich C++ code for which doxygen's built-in parser lacks the necessary type
# information.
# Note: The availability of this option depends on whether or not doxygen was
# generated with the -Duse_libclang=ON option for CMake.
# The default value is: NO.
CLANG_ASSISTED_PARSING = NO
# If clang assisted parsing is enabled you can provide the compiler with command
# line options that you would normally use when invoking the compiler. Note that
# the include paths will already be set by doxygen for the files and directories
# specified with INPUT and INCLUDE_PATH.
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
CLANG_OPTIONS =
# If clang assisted parsing is enabled you can provide the clang parser with the
# path to the compilation database (see:
# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
# were built. This is equivalent to specifying the "-p" option to a clang tool,
# such as clang-check. These options will then be passed to the parser.
# Note: The availability of this option depends on whether or not doxygen was
# generated with the -Duse_libclang=ON option for CMake.
CLANG_DATABASE_PATH =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index # Configuration options related to the alphabetical class index
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
@ -1279,7 +1308,7 @@ HTML_DYNAMIC_MENUS = YES
# The default value is: NO. # The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES. # This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_SECTIONS = NO HTML_DYNAMIC_SECTIONS = YES
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand # shown in the various tree structured indices initially; the user can expand
@ -1989,7 +2018,7 @@ MAN_OUTPUT = man
# The default value is: .3. # The default value is: .3.
# This tag requires that the tag GENERATE_MAN is set to YES. # This tag requires that the tag GENERATE_MAN is set to YES.
MAN_EXTENSION = .9 MAN_EXTENSION = .9o
# The MAN_SUBDIR tag determines the name of the directory created within # The MAN_SUBDIR tag determines the name of the directory created within
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by

File diff suppressed because it is too large Load Diff

View File

@ -73,14 +73,17 @@ void tasking_create_task(void* eip,void* cr3,char kmode,char param1_exists,void*
void tasking_init(); void tasking_init();
/** /**
* Check whether the current process is privleged * Check whether the current process is privleged
* \return whether the current process is privleged
*/ */
char tasking_is_privleged(); char tasking_is_privleged();
/** /**
* Get the PID of the current thread. * Get the PID of the current thread.
* \return The current thread's PID
*/ */
pid_t tasking_get_PID(); pid_t tasking_get_PID();
/** /**
* Get the adddress of errno for the current thread * Get the adddress of errno for the current thread
* \return The address of errno
*/ */
int* tasking_get_errno_address(); int* tasking_get_errno_address();
/** /**
@ -97,6 +100,7 @@ pid_t tasking_new_thread(void* start,pid_t pid,char param_exists,void* param_arg
* Terminate the current thread * Terminate the current thread
* If the main thread terminates, the whole process terminates. * If the main thread terminates, the whole process terminates.
* \note Currently, calling tasking_exit from any thread terminates the whole process. * \note Currently, calling tasking_exit from any thread terminates the whole process.
* \param code The exit code of the thread
*/ */
void tasking_exit(int code); void tasking_exit(int code);
/** /**

View File

@ -7,11 +7,13 @@
/** /**
* Initilaze the VGA error writing driver * Initilaze the VGA error writing driver
* \param screen Pointer to VGA screen memory
*/ */
void vga_init(char* screen); void vga_init(char* screen);
/** /**
* Write a string starting at the top line of the VGA display * Write a string starting at the top line of the VGA display
* \param string The string to write
*/ */
void vga_write_string(const char *string); void vga_write_string(const char *string);