DoxyGen: Added issue with cross references to How2Doc.txt.
@@ -215,7 +215,7 @@ Example:
The file documents each function that is exposed in *.h header file (and only those functions).
In case that functions are described in other files (i.e. USB Class Templates) there is a reference.
-Functional Group assignements uses this syntax:
+Functional Group assignments uses this syntax:
---------------------------
/**
\defgroup a group definition
@@ -267,3 +267,15 @@ void ftp_server_notify (uint8_t event) {
\endcode
+
+Cross references (between components)
+-------------------------------------
+
+Within a single component (same .dxy configuration) one can easily created cross references.
+Known symbol names are automatically assumed as a reference by Doxygen. Pages, sections and
+subsections can be referenced using "\ref" notation.
+
+Cross references do not work between different components, though. Doxygen offers the possibility
+to import so called tags (symbol and section names) from an another external documentation.
+Unfortunately this creates output that crashes the MDK DoxyIndex importer. Hence cross references
+needs to be placed manually using <a href="[url]">...</a> notation, for the time being.
