Skip to content

Commit

Permalink
#3: dd common Doxygen files
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed May 10, 2023
1 parent 5942c7f commit ad8fcd9
Show file tree
Hide file tree
Showing 9 changed files with 4,618 additions and 0 deletions.
2,787 changes: 2,787 additions & 0 deletions doxygen/common-config.doxyfile

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions doxygen/common-custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/* Placeholder for future project customisations. */
89 changes: 89 additions & 0 deletions doxygen/common-header.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
<!-- HTML header for doxygen 1.9.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="$langISO">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen $doxygenversion"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN FULL_SIDEBAR-->
<script type="text/javascript">var page_layout=1;</script>
<!--END FULL_SIDEBAR-->
<!--END DISABLE_INDEX-->
<script type="text/javascript" src="$relpath^jquery.js"></script>
<script type="text/javascript" src="$relpath^dynsections.js"></script>
$treeview
$search
$mathjax
$darkmode
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
$extrastylesheet
<!-- Awesome Theme Begin -->
<script type="text/javascript" src="$relpath^doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript" src="$relpath^doxygen-awesome-fragment-copy-button.js"></script>
<script type="text/javascript" src="$relpath^doxygen-awesome-paragraph-link.js"></script>
<script type="text/javascript" src="$relpath^doxygen-awesome-interactive-toc.js"></script>
<script type="text/javascript" src="$relpath^doxygen-awesome-tabs.js"></script>

<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
DoxygenAwesomeFragmentCopyButton.init()
DoxygenAwesomeParagraphLink.init()
DoxygenAwesomeInteractiveToc.init()
DoxygenAwesomeTabs.init()
</script>
<!-- Awesome Theme End -->
</head>
<body>
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN FULL_SIDEBAR-->
<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
<!--END FULL_SIDEBAR-->
<!--END DISABLE_INDEX-->

<div id="top"><!-- do not remove this div, it is closed by doxygen! -->

<!--BEGIN TITLEAREA-->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<!--BEGIN PROJECT_LOGO-->
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
<!--END PROJECT_LOGO-->
<!--BEGIN PROJECT_NAME-->
<td id="projectalign">
<div id="projectname">$projectname<!--BEGIN PROJECT_NUMBER--><span id="projectnumber">&#160;$projectnumber</span><!--END PROJECT_NUMBER-->
</div>
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
</td>
<!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME-->
<!--BEGIN PROJECT_BRIEF-->
<td>
<div id="projectbrief">$projectbrief</div>
</td>
<!--END PROJECT_BRIEF-->
<!--END !PROJECT_NAME-->
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN SEARCHENGINE-->
<!--BEGIN !FULL_SIDEBAR-->
<td>$searchbox</td>
<!--END !FULL_SIDEBAR-->
<!--END SEARCHENGINE-->
<!--END DISABLE_INDEX-->
</tr>
<!--BEGIN SEARCHENGINE-->
<!--BEGIN FULL_SIDEBAR-->
<tr><td colspan="2">$searchbox</td></tr>
<!--END FULL_SIDEBAR-->
<!--END SEARCHENGINE-->
</tbody>
</table>
</div>
<!--END TITLEAREA-->
<!-- end header part -->
97 changes: 97 additions & 0 deletions doxygen/pages/module-config.doxygen
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
/*
* This file is part of the µOS++ distribution.
* (https://github.com/micro-os-plus)
* Copyright (c) 2016 Liviu Ionescu.
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom
* the Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/

// ----------------------------------------------------------------------------

/**
@defgroup cmsis-plus-app-config-cmdline Command Line Options
@ingroup cmsis-plus-app-config
@brief Definitions passed via the compiler command line.
@details
Most of the configuration options can be passed via the configuration file,
but this requires each source file to include the configuration files.
However some options are too important to be missed and should be
passed via the compiler command line.
*/

/**
@defgroup cmsis-plus-app-config-startup Start-up & General Options
@ingroup cmsis-plus-app-config
@brief Definitions used to configure the program start-up.
@details
*/

/**
@defgroup cmsis-plus-app-config-mem Memory Management Options
@ingroup cmsis-plus-app-config
@brief Definitions used to configure the memory management features.
@details
*/

/**
@defgroup cmsis-plus-app-config-lib Library Options
@ingroup cmsis-plus-app-config
@brief Definitions used to configure various library options.
@details
*/

/**
@defgroup cmsis-plus-app-config-rtos RTOS Options
@ingroup cmsis-plus-app-config
@brief Definitions used to configure the RTOS.
@details
*/

/**
@defgroup cmsis-plus-app-config-trace Trace Options
@ingroup cmsis-plus-app-config
@brief Definitions used to configure the trace channel.
@details
In addition to the global `TRACE` definition, it is possible to
enable individual groups of messages, using separate definitions.
*/

/**
@defgroup cmsis-plus-app-config-port Custom RTOS Options
@ingroup cmsis-plus-app-config
@brief Definitions used to select various custom RTOS port implementations.
@details
The µOS++ RTOS API can be configured to run on top of another
RTOS scheduler (like FreeRTOS). It is also possible to select
each synchronisation objects to use either the custom port objects or
the µOS++ reference C++ implementations.
*/

/**
@defgroup cmsis-plus-app-config-info Informative Options
@ingroup cmsis-plus-app-config
@brief Definitions passed back to the application.
@details
Definitions originated in the µOS++ headers, useful to the application.
*/

// ----------------------------------------------------------------------------
75 changes: 75 additions & 0 deletions doxygen/pages/module-posix-io.doxygen
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
/*
* This file is part of the µOS++ distribution.
* (https://github.com/micro-os-plus)
* Copyright (c) 2016 Liviu Ionescu.
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom
* the Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/

// ----------------------------------------------------------------------------

/**
@defgroup cmsis-plus-posix-io-base Basic classes
@ingroup cmsis-plus-posix-io
@brief µOS++ POSIX I/O C++ basic classes.
@details
This page groups the classes providing support for standard
POSIX I/O operations.

TODO: add content
*/

/**
@defgroup cmsis-plus-posix-io-func Functions
@ingroup cmsis-plus-posix-io
@brief µOS++ POSIX I/O C++ functions.
@details
This page groups the functions providing support for standard
POSIX I/O operations.

TODO: add content
*/

/**
@defgroup cmsis-plus-posix-io-drivers Driver classes
@ingroup cmsis-plus-posix-io
@brief µOS++ POSIX I/O C++ drivers.
@details
This page groups the driver classes providing implemetations for the
POSIX I/O devices.

TODO: add content
*/

/**
@defgroup cmsis-plus-posix-io-utils Utility classes
@ingroup cmsis-plus-posix-io
@brief µOS++ POSIX I/O C++ utilites.
@details
This page groups the classes providing various utilities used in the
POSIX I/O subsistem.

TODO: add content
*/


// ----------------------------------------------------------------------------
Loading

0 comments on commit ad8fcd9

Please sign in to comment.