diff options
| -rw-r--r-- | docs/Doxyfile | 44 | ||||
| -rw-r--r-- | docs/ch.txt | 14 | ||||
| -rw-r--r-- | docs/img/readylist.png | bin | 0 -> 7883 bytes | |||
| -rw-r--r-- | docs/img/states.png | bin | 0 -> 29897 bytes | |||
| -rw-r--r-- | docs/img/workspace.png | bin | 0 -> 14430 bytes | |||
| -rw-r--r-- | readme.txt | 1 | ||||
| -rw-r--r-- | src/include/delta.h | 1 | ||||
| -rw-r--r-- | src/include/lists.h | 1 | ||||
| -rw-r--r-- | src/include/mutexes.h | 3 | ||||
| -rw-r--r-- | src/include/threads.h | 1 |
10 files changed, 50 insertions, 15 deletions
diff --git a/docs/Doxyfile b/docs/Doxyfile index 229408920..b9baae9ad 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.5.5 +# Doxyfile 1.5.7.1 #--------------------------------------------------------------------------- # Project related configuration options @@ -31,7 +31,6 @@ SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO -DETAILS_AT_TOP = YES INHERIT_DOCS = NO SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 2 @@ -43,9 +42,11 @@ OPTIMIZE_OUTPUT_VHDL = NO BUILTIN_STL_SUPPORT = NO CPP_CLI_SUPPORT = NO SIP_SUPPORT = NO +IDL_PROPERTY_SUPPORT = YES DISTRIBUTE_GROUP_DOC = NO SUBGROUPING = YES TYPEDEF_HIDES_STRUCT = NO +SYMBOL_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -76,7 +77,10 @@ ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = NO SHOW_DIRECTORIES = NO +SHOW_FILES = YES +SHOW_NAMESPACES = YES FILE_VERSION_FILTER = +LAYOUT_FILE = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- @@ -163,20 +167,27 @@ HTML_HEADER = HTML_FOOTER = HTML_STYLESHEET = HTML_ALIGN_MEMBERS = YES -GENERATE_HTMLHELP = NO +HTML_DYNAMIC_SECTIONS = NO GENERATE_DOCSET = NO DOCSET_FEEDNAME = "Doxygen generated docs" DOCSET_BUNDLE_ID = org.doxygen.Project -HTML_DYNAMIC_SECTIONS = NO +GENERATE_HTMLHELP = NO CHM_FILE = HHC_LOCATION = GENERATE_CHI = NO +CHM_INDEX_ENCODING = BINARY_TOC = NO TOC_EXPAND = NO +GENERATE_QHP = NO +QCH_FILE = +QHP_NAMESPACE = org.doxygen.Project +QHP_VIRTUAL_FOLDER = doc +QHG_LOCATION = DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 4 GENERATE_TREEVIEW = YES TREEVIEW_WIDTH = 250 +FORMULA_FONTSIZE = 10 #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- @@ -188,8 +199,8 @@ COMPACT_LATEX = NO PAPER_TYPE = a4wide EXTRA_PACKAGES = LATEX_HEADER = -PDF_HYPERLINKS = NO -USE_PDFLATEX = NO +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO #--------------------------------------------------------------------------- @@ -277,25 +288,28 @@ PERL_PATH = /usr/bin/perl CLASS_DIAGRAMS = NO MSCGEN_PATH = HIDE_UNDOC_RELATIONS = YES -HAVE_DOT = NO +HAVE_DOT = YES +DOT_FONTNAME = FreeSans +DOT_FONTSIZE = 8 +DOT_FONTPATH = CLASS_GRAPH = YES COLLABORATION_GRAPH = YES GROUP_GRAPHS = YES -UML_LOOK = NO +UML_LOOK = YES TEMPLATE_RELATIONS = NO INCLUDE_GRAPH = YES -INCLUDED_BY_GRAPH = YES -CALL_GRAPH = NO +INCLUDED_BY_GRAPH = NO +CALL_GRAPH = YES CALLER_GRAPH = NO GRAPHICAL_HIERARCHY = YES -DIRECTORY_GRAPH = YES +DIRECTORY_GRAPH = NO DOT_IMAGE_FORMAT = png DOT_PATH = DOTFILE_DIRS = -DOT_GRAPH_MAX_NODES = 50 -MAX_DOT_GRAPH_DEPTH = 1000 -DOT_TRANSPARENT = NO -DOT_MULTI_TARGETS = NO +DOT_GRAPH_MAX_NODES = 10 +MAX_DOT_GRAPH_DEPTH = 3 +DOT_TRANSPARENT = YES +DOT_MULTI_TARGETS = YES GENERATE_LEGEND = YES DOT_CLEANUP = YES #--------------------------------------------------------------------------- diff --git a/docs/ch.txt b/docs/ch.txt index 8f813d62f..05d38e33c 100644 --- a/docs/ch.txt +++ b/docs/ch.txt @@ -230,6 +230,20 @@ /** @} */
/**
+ * @defgroup STM32F103 STM32F103 Support
+ * @{
+ * <p>
+ * The STM32F103 support includes:
+ * <ul>
+ * <li>Buffered, interrupt driven, serial driver.</li>
+ * <li>A demo supporting the kernel test suite.</li>
+ * </ul>
+ * </p>
+ * @ingroup ARMCM3
+ */
+/** @} */
+
+/**
* @defgroup AVR MegaAVR
* @{
* <p>
diff --git a/docs/img/readylist.png b/docs/img/readylist.png Binary files differnew file mode 100644 index 000000000..4d852388f --- /dev/null +++ b/docs/img/readylist.png diff --git a/docs/img/states.png b/docs/img/states.png Binary files differnew file mode 100644 index 000000000..05a61fcb4 --- /dev/null +++ b/docs/img/states.png diff --git a/docs/img/workspace.png b/docs/img/workspace.png Binary files differnew file mode 100644 index 000000000..03149b7bd --- /dev/null +++ b/docs/img/workspace.png diff --git a/readme.txt b/readme.txt index a6a399d03..8daa3d017 100644 --- a/readme.txt +++ b/readme.txt @@ -93,6 +93,7 @@ Win32-MinGW - ChibiOS/RT simulator and demo into a WIN32 process, vectors.s files.
- Modified the STM32 demo makefile to use the latest YAGARTO toolchain as
default (arm-elf-gcc).
+- Documentation improvements, added collaboration diagrams and call graphs.
*** 0.7.1 ***
- NEW: New chThdInit() and chThdCreateStatic() APIs now replace the old
diff --git a/src/include/delta.h b/src/include/delta.h index 66f6fcc0a..4d59c1a73 100644 --- a/src/include/delta.h +++ b/src/include/delta.h @@ -34,6 +34,7 @@ typedef struct VirtualTimer VirtualTimer; /**
* Virtual Timer descriptor structure.
+ * @extends DeltaList
*/
struct VirtualTimer {
/** Next timer in the delta list.*/
diff --git a/src/include/lists.h b/src/include/lists.h index 741648a03..5c3c98093 100644 --- a/src/include/lists.h +++ b/src/include/lists.h @@ -33,6 +33,7 @@ typedef struct Thread Thread; /**
* Generic threads queue header and element.
+ * @extends ThreadsList
*/
typedef struct {
/** First \p Thread in the queue, or \p ThreadQueue when empty. */
diff --git a/src/include/mutexes.h b/src/include/mutexes.h index dcb2039ff..31797562b 100644 --- a/src/include/mutexes.h +++ b/src/include/mutexes.h @@ -29,6 +29,9 @@ typedef struct Mutex Mutex;
+/**
+ * Mutex structure.
+ */
struct Mutex {
/** Queue of the threads sleeping on this Mutex.*/
ThreadsQueue m_queue;
diff --git a/src/include/threads.h b/src/include/threads.h index 099b8466f..051ca482d 100644 --- a/src/include/threads.h +++ b/src/include/threads.h @@ -27,6 +27,7 @@ /** * Structure representing a thread. + * @extends ThreadsQueue * @note Not all the listed fields are always needed, by switching off some * not needed ChibiOS/RT subsystems it is possible to save RAM space by * shrinking the \p Thread structure. |
