テスト用のあれこれ共用フォルダ
修訂 | ce03b2ba4c603828729c61602467e60387ba67a6 (tree) |
---|---|
時間 | 2018-03-06 08:35:35 |
作者 | takemasa <suikan@user...> |
Commiter | takemasa |
Change the member function name of AbstractSpiMaster. This change makes
consistensy of the name among classes better
Added predefined macro to the doxygen configuration file, to enable the
doc generation for uart/spimaster/i2c always.
@@ -6,7 +6,7 @@ | ||
6 | 6 | <provider-reference id="org.eclipse.cdt.core.ReferencedProjectsLanguageSettingsProvider" ref="shared-provider"/> |
7 | 7 | <provider-reference id="org.eclipse.cdt.managedbuilder.core.MBSLanguageSettingsProvider" ref="shared-provider"/> |
8 | 8 | <provider copy-of="extension" id="org.eclipse.cdt.managedbuilder.core.GCCBuildCommandParser"/> |
9 | - <provider class="fr.ac6.mcu.ide.build.CrossBuiltinSpecsDetector" console="false" env-hash="-964660132747690961" id="fr.ac6.mcu.ide.build.CrossBuiltinSpecsDetector" keep-relative-paths="false" name="Ac6 SW4 STM32 MCU Built-in Compiler Settings" parameter="${COMMAND} ${FLAGS} -E -P -v -dD "${INPUTS}"" prefer-non-shared="true"> | |
9 | + <provider class="fr.ac6.mcu.ide.build.CrossBuiltinSpecsDetector" console="false" env-hash="-1464480601815891179" id="fr.ac6.mcu.ide.build.CrossBuiltinSpecsDetector" keep-relative-paths="false" name="Ac6 SW4 STM32 MCU Built-in Compiler Settings" parameter="${COMMAND} ${FLAGS} -E -P -v -dD "${INPUTS}"" prefer-non-shared="true"> | |
10 | 10 | <language-scope id="org.eclipse.cdt.core.gcc"/> |
11 | 11 | <language-scope id="org.eclipse.cdt.core.g++"/> |
12 | 12 | </provider> |
@@ -18,7 +18,7 @@ | ||
18 | 18 | <provider-reference id="org.eclipse.cdt.core.ReferencedProjectsLanguageSettingsProvider" ref="shared-provider"/> |
19 | 19 | <provider-reference id="org.eclipse.cdt.managedbuilder.core.MBSLanguageSettingsProvider" ref="shared-provider"/> |
20 | 20 | <provider copy-of="extension" id="org.eclipse.cdt.managedbuilder.core.GCCBuildCommandParser"/> |
21 | - <provider class="fr.ac6.mcu.ide.build.CrossBuiltinSpecsDetector" console="false" env-hash="-964660132747690961" id="fr.ac6.mcu.ide.build.CrossBuiltinSpecsDetector" keep-relative-paths="false" name="Ac6 SW4 STM32 MCU Built-in Compiler Settings" parameter="${COMMAND} ${FLAGS} -E -P -v -dD "${INPUTS}"" prefer-non-shared="true"> | |
21 | + <provider class="fr.ac6.mcu.ide.build.CrossBuiltinSpecsDetector" console="false" env-hash="-1464480601815891179" id="fr.ac6.mcu.ide.build.CrossBuiltinSpecsDetector" keep-relative-paths="false" name="Ac6 SW4 STM32 MCU Built-in Compiler Settings" parameter="${COMMAND} ${FLAGS} -E -P -v -dD "${INPUTS}"" prefer-non-shared="true"> | |
22 | 22 | <language-scope id="org.eclipse.cdt.core.gcc"/> |
23 | 23 | <language-scope id="org.eclipse.cdt.core.g++"/> |
24 | 24 | </provider> |
@@ -155,7 +155,7 @@ void HAL_UART_RxCpltCallback(UART_HandleTypeDef * huart) | ||
155 | 155 | |
156 | 156 | void HAL_SPI_TxRxCpltCallback(SPI_HandleTypeDef * hspi) |
157 | 157 | { |
158 | - if (murasaki::platform.spi_master->TransferCompleteCallback(hspi)) | |
158 | + if (murasaki::platform.spi_master->TransmitAndReceiveCompleteCallback(hspi)) | |
159 | 159 | return; |
160 | 160 | } |
161 | 161 |
@@ -38,7 +38,7 @@ PROJECT_NAME = "Murasaki Class Library" | ||
38 | 38 | # could be handy for archiving the generated documentation or if some version |
39 | 39 | # control system is used. |
40 | 40 | |
41 | -PROJECT_NUMBER = | |
41 | +PROJECT_NUMBER = | |
42 | 42 | |
43 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description |
44 | 44 | # for a project that appears at the top of each page and should give viewer a |
@@ -51,14 +51,14 @@ PROJECT_BRIEF = "A peripheral controll class collections for the STM32 microproc | ||
51 | 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy |
52 | 52 | # the logo to the output directory. |
53 | 53 | |
54 | -PROJECT_LOGO = | |
54 | +PROJECT_LOGO = | |
55 | 55 | |
56 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path |
57 | 57 | # into which the generated documentation will be written. If a relative path is |
58 | 58 | # entered, it will be relative to the location where doxygen was started. If |
59 | 59 | # left blank the current directory will be used. |
60 | 60 | |
61 | -OUTPUT_DIRECTORY = | |
61 | +OUTPUT_DIRECTORY = | |
62 | 62 | |
63 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- |
64 | 64 | # directories (in 2 levels) under the output directory of each output format and |
@@ -118,7 +118,7 @@ REPEAT_BRIEF = YES | ||
118 | 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, |
119 | 119 | # specifies, contains, represents, a, an and the. |
120 | 120 | |
121 | -ABBREVIATE_BRIEF = | |
121 | +ABBREVIATE_BRIEF = | |
122 | 122 | |
123 | 123 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
124 | 124 | # doxygen will generate a detailed section even if there is only a brief |
@@ -152,7 +152,7 @@ FULL_PATH_NAMES = YES | ||
152 | 152 | # will be relative from the directory where doxygen is started. |
153 | 153 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. |
154 | 154 | |
155 | -STRIP_FROM_PATH = | |
155 | +STRIP_FROM_PATH = | |
156 | 156 | |
157 | 157 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the |
158 | 158 | # path mentioned in the documentation of a class, which tells the reader which |
@@ -161,7 +161,7 @@ STRIP_FROM_PATH = | ||
161 | 161 | # specify the list of include paths that are normally passed to the compiler |
162 | 162 | # using the -I flag. |
163 | 163 | |
164 | -STRIP_FROM_INC_PATH = | |
164 | +STRIP_FROM_INC_PATH = | |
165 | 165 | |
166 | 166 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but |
167 | 167 | # less readable) file names. This can be useful is your file systems doesn't |
@@ -228,13 +228,13 @@ TAB_SIZE = 4 | ||
228 | 228 | # "Side Effects:". You can put \n's in the value part of an alias to insert |
229 | 229 | # newlines. |
230 | 230 | |
231 | -ALIASES = | |
231 | +ALIASES = | |
232 | 232 | |
233 | 233 | # This tag can be used to specify a number of word-keyword mappings (TCL only). |
234 | 234 | # A mapping has the form "name=value". For example adding "class=itcl::class" |
235 | 235 | # will allow you to use the command class in the itcl::class meaning. |
236 | 236 | |
237 | -TCL_SUBST = | |
237 | +TCL_SUBST = | |
238 | 238 | |
239 | 239 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
240 | 240 | # only. Doxygen will then generate output that is more tailored for C. For |
@@ -281,7 +281,7 @@ OPTIMIZE_OUTPUT_VHDL = NO | ||
281 | 281 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise |
282 | 282 | # the files are not read by doxygen. |
283 | 283 | |
284 | -EXTENSION_MAPPING = | |
284 | +EXTENSION_MAPPING = | |
285 | 285 | |
286 | 286 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments |
287 | 287 | # according to the Markdown format, which allows for more readable |
@@ -629,7 +629,7 @@ GENERATE_DEPRECATEDLIST = YES | ||
629 | 629 | # sections, marked by \if <section_label> ... \endif and \cond <section_label> |
630 | 630 | # ... \endcond blocks. |
631 | 631 | |
632 | -ENABLED_SECTIONS = | |
632 | +ENABLED_SECTIONS = | |
633 | 633 | |
634 | 634 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the |
635 | 635 | # initial value of a variable or macro / define can have for it to appear in the |
@@ -671,7 +671,7 @@ SHOW_NAMESPACES = YES | ||
671 | 671 | # by doxygen. Whatever the program writes to standard output is used as the file |
672 | 672 | # version. For an example see the documentation. |
673 | 673 | |
674 | -FILE_VERSION_FILTER = | |
674 | +FILE_VERSION_FILTER = | |
675 | 675 | |
676 | 676 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed |
677 | 677 | # by doxygen. The layout file controls the global structure of the generated |
@@ -684,7 +684,7 @@ FILE_VERSION_FILTER = | ||
684 | 684 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE |
685 | 685 | # tag is left empty. |
686 | 686 | |
687 | -LAYOUT_FILE = | |
687 | +LAYOUT_FILE = | |
688 | 688 | |
689 | 689 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing |
690 | 690 | # the reference definitions. This must be a list of .bib files. The .bib |
@@ -694,7 +694,7 @@ LAYOUT_FILE = | ||
694 | 694 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the |
695 | 695 | # search path. See also \cite for info how to create references. |
696 | 696 | |
697 | -CITE_BIB_FILES = | |
697 | +CITE_BIB_FILES = | |
698 | 698 | |
699 | 699 | #--------------------------------------------------------------------------- |
700 | 700 | # Configuration options related to warning and progress messages |
@@ -759,7 +759,7 @@ WARN_FORMAT = "$file:$line: $text" | ||
759 | 759 | # messages should be written. If left blank the output is written to standard |
760 | 760 | # error (stderr). |
761 | 761 | |
762 | -WARN_LOGFILE = | |
762 | +WARN_LOGFILE = | |
763 | 763 | |
764 | 764 | #--------------------------------------------------------------------------- |
765 | 765 | # Configuration options related to the input files |
@@ -796,7 +796,7 @@ INPUT_ENCODING = UTF-8 | ||
796 | 796 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, |
797 | 797 | # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. |
798 | 798 | |
799 | -FILE_PATTERNS = | |
799 | +FILE_PATTERNS = | |
800 | 800 | |
801 | 801 | # The RECURSIVE tag can be used to specify whether or not subdirectories should |
802 | 802 | # be searched for input files as well. |
@@ -811,7 +811,7 @@ RECURSIVE = YES | ||
811 | 811 | # Note that relative paths are relative to the directory from which doxygen is |
812 | 812 | # run. |
813 | 813 | |
814 | -EXCLUDE = | |
814 | +EXCLUDE = | |
815 | 815 | |
816 | 816 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or |
817 | 817 | # directories that are symbolic links (a Unix file system feature) are excluded |
@@ -827,7 +827,7 @@ EXCLUDE_SYMLINKS = NO | ||
827 | 827 | # Note that the wildcards are matched against the file with absolute path, so to |
828 | 828 | # exclude all test directories for example use the pattern */test/* |
829 | 829 | |
830 | -EXCLUDE_PATTERNS = | |
830 | +EXCLUDE_PATTERNS = | |
831 | 831 | |
832 | 832 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
833 | 833 | # (namespaces, classes, functions, etc.) that should be excluded from the |
@@ -838,7 +838,7 @@ EXCLUDE_PATTERNS = | ||
838 | 838 | # Note that the wildcards are matched against the file with absolute path, so to |
839 | 839 | # exclude all test directories use the pattern */test/* |
840 | 840 | |
841 | -EXCLUDE_SYMBOLS = | |
841 | +EXCLUDE_SYMBOLS = | |
842 | 842 | |
843 | 843 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories |
844 | 844 | # that contain example code fragments that are included (see the \include |
@@ -851,7 +851,7 @@ EXAMPLE_PATH = Middlewares Drivers | ||
851 | 851 | # *.h) to filter out the source-files in the directories. If left blank all |
852 | 852 | # files are included. |
853 | 853 | |
854 | -EXAMPLE_PATTERNS = | |
854 | +EXAMPLE_PATTERNS = | |
855 | 855 | |
856 | 856 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
857 | 857 | # searched for input files to be used with the \include or \dontinclude commands |
@@ -864,7 +864,7 @@ EXAMPLE_RECURSIVE = NO | ||
864 | 864 | # that contain images that are to be included in the documentation (see the |
865 | 865 | # \image command). |
866 | 866 | |
867 | -IMAGE_PATH = | |
867 | +IMAGE_PATH = | |
868 | 868 | |
869 | 869 | # The INPUT_FILTER tag can be used to specify a program that doxygen should |
870 | 870 | # invoke to filter for each input file. Doxygen will invoke the filter program |
@@ -885,7 +885,7 @@ IMAGE_PATH = | ||
885 | 885 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not |
886 | 886 | # properly processed by doxygen. |
887 | 887 | |
888 | -INPUT_FILTER = | |
888 | +INPUT_FILTER = | |
889 | 889 | |
890 | 890 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
891 | 891 | # basis. Doxygen will compare the file name with each pattern and apply the |
@@ -898,7 +898,7 @@ INPUT_FILTER = | ||
898 | 898 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not |
899 | 899 | # properly processed by doxygen. |
900 | 900 | |
901 | -FILTER_PATTERNS = | |
901 | +FILTER_PATTERNS = | |
902 | 902 | |
903 | 903 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
904 | 904 | # INPUT_FILTER) will also be used to filter the input files that are used for |
@@ -913,14 +913,14 @@ FILTER_SOURCE_FILES = NO | ||
913 | 913 | # *.ext= (so without naming a filter). |
914 | 914 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. |
915 | 915 | |
916 | -FILTER_SOURCE_PATTERNS = | |
916 | +FILTER_SOURCE_PATTERNS = | |
917 | 917 | |
918 | 918 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that |
919 | 919 | # is part of the input, its contents will be placed on the main page |
920 | 920 | # (index.html). This can be useful if you have a project on for instance GitHub |
921 | 921 | # and want to reuse the introduction page also for the doxygen output. |
922 | 922 | |
923 | -USE_MDFILE_AS_MAINPAGE = | |
923 | +USE_MDFILE_AS_MAINPAGE = | |
924 | 924 | |
925 | 925 | #--------------------------------------------------------------------------- |
926 | 926 | # Configuration options related to source browsing |
@@ -1025,7 +1025,7 @@ CLANG_ASSISTED_PARSING = NO | ||
1025 | 1025 | # specified with INPUT and INCLUDE_PATH. |
1026 | 1026 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. |
1027 | 1027 | |
1028 | -CLANG_OPTIONS = | |
1028 | +CLANG_OPTIONS = | |
1029 | 1029 | |
1030 | 1030 | #--------------------------------------------------------------------------- |
1031 | 1031 | # Configuration options related to the alphabetical class index |
@@ -1051,7 +1051,7 @@ COLS_IN_ALPHA_INDEX = 5 | ||
1051 | 1051 | # while generating the index headers. |
1052 | 1052 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. |
1053 | 1053 | |
1054 | -IGNORE_PREFIX = | |
1054 | +IGNORE_PREFIX = | |
1055 | 1055 | |
1056 | 1056 | #--------------------------------------------------------------------------- |
1057 | 1057 | # Configuration options related to the HTML output |
@@ -1095,7 +1095,7 @@ HTML_FILE_EXTENSION = .html | ||
1095 | 1095 | # of the possible markers and block names see the documentation. |
1096 | 1096 | # This tag requires that the tag GENERATE_HTML is set to YES. |
1097 | 1097 | |
1098 | -HTML_HEADER = | |
1098 | +HTML_HEADER = | |
1099 | 1099 | |
1100 | 1100 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each |
1101 | 1101 | # generated HTML page. If the tag is left blank doxygen will generate a standard |
@@ -1105,7 +1105,7 @@ HTML_HEADER = | ||
1105 | 1105 | # that doxygen normally uses. |
1106 | 1106 | # This tag requires that the tag GENERATE_HTML is set to YES. |
1107 | 1107 | |
1108 | -HTML_FOOTER = | |
1108 | +HTML_FOOTER = | |
1109 | 1109 | |
1110 | 1110 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style |
1111 | 1111 | # sheet that is used by each HTML page. It can be used to fine-tune the look of |
@@ -1130,7 +1130,7 @@ HTML_STYLESHEET = doxygen.css | ||
1130 | 1130 | # list). For an example see the documentation. |
1131 | 1131 | # This tag requires that the tag GENERATE_HTML is set to YES. |
1132 | 1132 | |
1133 | -HTML_EXTRA_STYLESHEET = | |
1133 | +HTML_EXTRA_STYLESHEET = | |
1134 | 1134 | |
1135 | 1135 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or |
1136 | 1136 | # other source files which should be copied to the HTML output directory. Note |
@@ -1140,7 +1140,7 @@ HTML_EXTRA_STYLESHEET = | ||
1140 | 1140 | # files will be copied as-is; there are no commands or markers available. |
1141 | 1141 | # This tag requires that the tag GENERATE_HTML is set to YES. |
1142 | 1142 | |
1143 | -HTML_EXTRA_FILES = | |
1143 | +HTML_EXTRA_FILES = | |
1144 | 1144 | |
1145 | 1145 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen |
1146 | 1146 | # will adjust the colors in the style sheet and background images according to |
@@ -1269,7 +1269,7 @@ GENERATE_HTMLHELP = NO | ||
1269 | 1269 | # written to the html output directory. |
1270 | 1270 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1271 | 1271 | |
1272 | -CHM_FILE = | |
1272 | +CHM_FILE = | |
1273 | 1273 | |
1274 | 1274 | # The HHC_LOCATION tag can be used to specify the location (absolute path |
1275 | 1275 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, |
@@ -1277,7 +1277,7 @@ CHM_FILE = | ||
1277 | 1277 | # The file has to be specified with full path. |
1278 | 1278 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1279 | 1279 | |
1280 | -HHC_LOCATION = | |
1280 | +HHC_LOCATION = | |
1281 | 1281 | |
1282 | 1282 | # The GENERATE_CHI flag controls if a separate .chi index file is generated |
1283 | 1283 | # (YES) or that it should be included in the master .chm file (NO). |
@@ -1290,7 +1290,7 @@ GENERATE_CHI = NO | ||
1290 | 1290 | # and project file content. |
1291 | 1291 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1292 | 1292 | |
1293 | -CHM_INDEX_ENCODING = | |
1293 | +CHM_INDEX_ENCODING = | |
1294 | 1294 | |
1295 | 1295 | # The BINARY_TOC flag controls whether a binary table of contents is generated |
1296 | 1296 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it |
@@ -1321,7 +1321,7 @@ GENERATE_QHP = NO | ||
1321 | 1321 | # the HTML output folder. |
1322 | 1322 | # This tag requires that the tag GENERATE_QHP is set to YES. |
1323 | 1323 | |
1324 | -QCH_FILE = | |
1324 | +QCH_FILE = | |
1325 | 1325 | |
1326 | 1326 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help |
1327 | 1327 | # Project output. For more information please see Qt Help Project / Namespace |
@@ -1346,7 +1346,7 @@ QHP_VIRTUAL_FOLDER = doc | ||
1346 | 1346 | # filters). |
1347 | 1347 | # This tag requires that the tag GENERATE_QHP is set to YES. |
1348 | 1348 | |
1349 | -QHP_CUST_FILTER_NAME = | |
1349 | +QHP_CUST_FILTER_NAME = | |
1350 | 1350 | |
1351 | 1351 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the |
1352 | 1352 | # custom filter to add. For more information please see Qt Help Project / Custom |
@@ -1354,21 +1354,21 @@ QHP_CUST_FILTER_NAME = | ||
1354 | 1354 | # filters). |
1355 | 1355 | # This tag requires that the tag GENERATE_QHP is set to YES. |
1356 | 1356 | |
1357 | -QHP_CUST_FILTER_ATTRS = | |
1357 | +QHP_CUST_FILTER_ATTRS = | |
1358 | 1358 | |
1359 | 1359 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
1360 | 1360 | # project's filter section matches. Qt Help Project / Filter Attributes (see: |
1361 | 1361 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). |
1362 | 1362 | # This tag requires that the tag GENERATE_QHP is set to YES. |
1363 | 1363 | |
1364 | -QHP_SECT_FILTER_ATTRS = | |
1364 | +QHP_SECT_FILTER_ATTRS = | |
1365 | 1365 | |
1366 | 1366 | # The QHG_LOCATION tag can be used to specify the location of Qt's |
1367 | 1367 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the |
1368 | 1368 | # generated .qhp file. |
1369 | 1369 | # This tag requires that the tag GENERATE_QHP is set to YES. |
1370 | 1370 | |
1371 | -QHG_LOCATION = | |
1371 | +QHG_LOCATION = | |
1372 | 1372 | |
1373 | 1373 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be |
1374 | 1374 | # generated, together with the HTML files, they form an Eclipse help plugin. To |
@@ -1501,7 +1501,7 @@ MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest | ||
1501 | 1501 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols |
1502 | 1502 | # This tag requires that the tag USE_MATHJAX is set to YES. |
1503 | 1503 | |
1504 | -MATHJAX_EXTENSIONS = | |
1504 | +MATHJAX_EXTENSIONS = | |
1505 | 1505 | |
1506 | 1506 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces |
1507 | 1507 | # of code that will be used on startup of the MathJax code. See the MathJax site |
@@ -1509,7 +1509,7 @@ MATHJAX_EXTENSIONS = | ||
1509 | 1509 | # example see the documentation. |
1510 | 1510 | # This tag requires that the tag USE_MATHJAX is set to YES. |
1511 | 1511 | |
1512 | -MATHJAX_CODEFILE = | |
1512 | +MATHJAX_CODEFILE = | |
1513 | 1513 | |
1514 | 1514 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for |
1515 | 1515 | # the HTML output. The underlying search engine uses javascript and DHTML and |
@@ -1569,7 +1569,7 @@ EXTERNAL_SEARCH = NO | ||
1569 | 1569 | # Searching" for details. |
1570 | 1570 | # This tag requires that the tag SEARCHENGINE is set to YES. |
1571 | 1571 | |
1572 | -SEARCHENGINE_URL = | |
1572 | +SEARCHENGINE_URL = | |
1573 | 1573 | |
1574 | 1574 | # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed |
1575 | 1575 | # search data is written to a file for indexing by an external tool. With the |
@@ -1585,7 +1585,7 @@ SEARCHDATA_FILE = searchdata.xml | ||
1585 | 1585 | # projects and redirect the results back to the right project. |
1586 | 1586 | # This tag requires that the tag SEARCHENGINE is set to YES. |
1587 | 1587 | |
1588 | -EXTERNAL_SEARCH_ID = | |
1588 | +EXTERNAL_SEARCH_ID = | |
1589 | 1589 | |
1590 | 1590 | # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen |
1591 | 1591 | # projects other than the one defined by this configuration file, but that are |
@@ -1595,7 +1595,7 @@ EXTERNAL_SEARCH_ID = | ||
1595 | 1595 | # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... |
1596 | 1596 | # This tag requires that the tag SEARCHENGINE is set to YES. |
1597 | 1597 | |
1598 | -EXTRA_SEARCH_MAPPINGS = | |
1598 | +EXTRA_SEARCH_MAPPINGS = | |
1599 | 1599 | |
1600 | 1600 | #--------------------------------------------------------------------------- |
1601 | 1601 | # Configuration options related to the LaTeX output |
@@ -1659,7 +1659,7 @@ PAPER_TYPE = a4 | ||
1659 | 1659 | # If left blank no extra packages will be included. |
1660 | 1660 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
1661 | 1661 | |
1662 | -EXTRA_PACKAGES = | |
1662 | +EXTRA_PACKAGES = | |
1663 | 1663 | |
1664 | 1664 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the |
1665 | 1665 | # generated LaTeX document. The header should contain everything until the first |
@@ -1675,7 +1675,7 @@ EXTRA_PACKAGES = | ||
1675 | 1675 | # to HTML_HEADER. |
1676 | 1676 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
1677 | 1677 | |
1678 | -LATEX_HEADER = | |
1678 | +LATEX_HEADER = | |
1679 | 1679 | |
1680 | 1680 | # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the |
1681 | 1681 | # generated LaTeX document. The footer should contain everything after the last |
@@ -1686,7 +1686,7 @@ LATEX_HEADER = | ||
1686 | 1686 | # Note: Only use a user-defined footer if you know what you are doing! |
1687 | 1687 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
1688 | 1688 | |
1689 | -LATEX_FOOTER = | |
1689 | +LATEX_FOOTER = | |
1690 | 1690 | |
1691 | 1691 | # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined |
1692 | 1692 | # LaTeX style sheets that are included after the standard style sheets created |
@@ -1697,7 +1697,7 @@ LATEX_FOOTER = | ||
1697 | 1697 | # list). |
1698 | 1698 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
1699 | 1699 | |
1700 | -LATEX_EXTRA_STYLESHEET = | |
1700 | +LATEX_EXTRA_STYLESHEET = | |
1701 | 1701 | |
1702 | 1702 | # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or |
1703 | 1703 | # other source files which should be copied to the LATEX_OUTPUT output |
@@ -1705,7 +1705,7 @@ LATEX_EXTRA_STYLESHEET = | ||
1705 | 1705 | # markers available. |
1706 | 1706 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
1707 | 1707 | |
1708 | -LATEX_EXTRA_FILES = | |
1708 | +LATEX_EXTRA_FILES = | |
1709 | 1709 | |
1710 | 1710 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is |
1711 | 1711 | # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will |
@@ -1813,14 +1813,14 @@ RTF_HYPERLINKS = NO | ||
1813 | 1813 | # default style sheet that doxygen normally uses. |
1814 | 1814 | # This tag requires that the tag GENERATE_RTF is set to YES. |
1815 | 1815 | |
1816 | -RTF_STYLESHEET_FILE = | |
1816 | +RTF_STYLESHEET_FILE = | |
1817 | 1817 | |
1818 | 1818 | # Set optional variables used in the generation of an RTF document. Syntax is |
1819 | 1819 | # similar to doxygen's config file. A template extensions file can be generated |
1820 | 1820 | # using doxygen -e rtf extensionFile. |
1821 | 1821 | # This tag requires that the tag GENERATE_RTF is set to YES. |
1822 | 1822 | |
1823 | -RTF_EXTENSIONS_FILE = | |
1823 | +RTF_EXTENSIONS_FILE = | |
1824 | 1824 | |
1825 | 1825 | # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code |
1826 | 1826 | # with syntax highlighting in the RTF output. |
@@ -1865,7 +1865,7 @@ MAN_EXTENSION = .3 | ||
1865 | 1865 | # MAN_EXTENSION with the initial . removed. |
1866 | 1866 | # This tag requires that the tag GENERATE_MAN is set to YES. |
1867 | 1867 | |
1868 | -MAN_SUBDIR = | |
1868 | +MAN_SUBDIR = | |
1869 | 1869 | |
1870 | 1870 | # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it |
1871 | 1871 | # will generate one additional man file for each entity documented in the real |
@@ -1978,7 +1978,7 @@ PERLMOD_PRETTY = YES | ||
1978 | 1978 | # overwrite each other's variables. |
1979 | 1979 | # This tag requires that the tag GENERATE_PERLMOD is set to YES. |
1980 | 1980 | |
1981 | -PERLMOD_MAKEVAR_PREFIX = | |
1981 | +PERLMOD_MAKEVAR_PREFIX = | |
1982 | 1982 | |
1983 | 1983 | #--------------------------------------------------------------------------- |
1984 | 1984 | # Configuration options related to the preprocessor |
@@ -2027,7 +2027,7 @@ INCLUDE_PATH = src platform Inc | ||
2027 | 2027 | # used. |
2028 | 2028 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
2029 | 2029 | |
2030 | -INCLUDE_FILE_PATTERNS = | |
2030 | +INCLUDE_FILE_PATTERNS = | |
2031 | 2031 | |
2032 | 2032 | # The PREDEFINED tag can be used to specify one or more macro names that are |
2033 | 2033 | # defined before the preprocessor is started (similar to the -D option of e.g. |
@@ -2037,7 +2037,7 @@ INCLUDE_FILE_PATTERNS = | ||
2037 | 2037 | # recursively expanded use the := operator instead of the = operator. |
2038 | 2038 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
2039 | 2039 | |
2040 | -PREDEFINED = | |
2040 | +PREDEFINED = HAL_UART_MODULE_ENABLED HAL_I2C_MODULE_ENABLED HAL_SPI_MODULE_ENABLED | |
2041 | 2041 | |
2042 | 2042 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this |
2043 | 2043 | # tag can be used to specify a list of macro names that should be expanded. The |
@@ -2046,7 +2046,7 @@ PREDEFINED = | ||
2046 | 2046 | # definition found in the source code. |
2047 | 2047 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
2048 | 2048 | |
2049 | -EXPAND_AS_DEFINED = | |
2049 | +EXPAND_AS_DEFINED = | |
2050 | 2050 | |
2051 | 2051 | # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will |
2052 | 2052 | # remove all references to function-like macros that are alone on a line, have |
@@ -2075,13 +2075,13 @@ SKIP_FUNCTION_MACROS = YES | ||
2075 | 2075 | # the path). If a tag file is not located in the directory in which doxygen is |
2076 | 2076 | # run, you must also specify the path to the tagfile here. |
2077 | 2077 | |
2078 | -TAGFILES = | |
2078 | +TAGFILES = | |
2079 | 2079 | |
2080 | 2080 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create a |
2081 | 2081 | # tag file that is based on the input files it reads. See section "Linking to |
2082 | 2082 | # external documentation" for more information about the usage of tag files. |
2083 | 2083 | |
2084 | -GENERATE_TAGFILE = | |
2084 | +GENERATE_TAGFILE = | |
2085 | 2085 | |
2086 | 2086 | # If the ALLEXTERNALS tag is set to YES, all external class will be listed in |
2087 | 2087 | # the class index. If set to NO, only the inherited external classes will be |
@@ -2130,14 +2130,14 @@ CLASS_DIAGRAMS = YES | ||
2130 | 2130 | # the mscgen tool resides. If left empty the tool is assumed to be found in the |
2131 | 2131 | # default search path. |
2132 | 2132 | |
2133 | -MSCGEN_PATH = | |
2133 | +MSCGEN_PATH = | |
2134 | 2134 | |
2135 | 2135 | # You can include diagrams made with dia in doxygen documentation. Doxygen will |
2136 | 2136 | # then run dia to produce the diagram and insert it in the documentation. The |
2137 | 2137 | # DIA_PATH tag allows you to specify the directory where the dia binary resides. |
2138 | 2138 | # If left empty dia is assumed to be found in the default search path. |
2139 | 2139 | |
2140 | -DIA_PATH = | |
2140 | +DIA_PATH = | |
2141 | 2141 | |
2142 | 2142 | # If set to YES the inheritance and collaboration graphs will hide inheritance |
2143 | 2143 | # and usage relations if the target is undocumented or is not a class. |
@@ -2186,7 +2186,7 @@ DOT_FONTSIZE = 10 | ||
2186 | 2186 | # the path where dot can find it using this tag. |
2187 | 2187 | # This tag requires that the tag HAVE_DOT is set to YES. |
2188 | 2188 | |
2189 | -DOT_FONTPATH = | |
2189 | +DOT_FONTPATH = | |
2190 | 2190 | |
2191 | 2191 | # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for |
2192 | 2192 | # each documented class showing the direct and indirect inheritance relations. |
@@ -2332,26 +2332,26 @@ INTERACTIVE_SVG = NO | ||
2332 | 2332 | # found. If left blank, it is assumed the dot tool can be found in the path. |
2333 | 2333 | # This tag requires that the tag HAVE_DOT is set to YES. |
2334 | 2334 | |
2335 | -DOT_PATH = | |
2335 | +DOT_PATH = | |
2336 | 2336 | |
2337 | 2337 | # The DOTFILE_DIRS tag can be used to specify one or more directories that |
2338 | 2338 | # contain dot files that are included in the documentation (see the \dotfile |
2339 | 2339 | # command). |
2340 | 2340 | # This tag requires that the tag HAVE_DOT is set to YES. |
2341 | 2341 | |
2342 | -DOTFILE_DIRS = | |
2342 | +DOTFILE_DIRS = | |
2343 | 2343 | |
2344 | 2344 | # The MSCFILE_DIRS tag can be used to specify one or more directories that |
2345 | 2345 | # contain msc files that are included in the documentation (see the \mscfile |
2346 | 2346 | # command). |
2347 | 2347 | |
2348 | -MSCFILE_DIRS = | |
2348 | +MSCFILE_DIRS = | |
2349 | 2349 | |
2350 | 2350 | # The DIAFILE_DIRS tag can be used to specify one or more directories that |
2351 | 2351 | # contain dia files that are included in the documentation (see the \diafile |
2352 | 2352 | # command). |
2353 | 2353 | |
2354 | -DIAFILE_DIRS = | |
2354 | +DIAFILE_DIRS = | |
2355 | 2355 | |
2356 | 2356 | # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the |
2357 | 2357 | # path where java can find the plantuml.jar file. If left blank, it is assumed |
@@ -2359,12 +2359,12 @@ DIAFILE_DIRS = | ||
2359 | 2359 | # generate a warning when it encounters a \startuml command in this case and |
2360 | 2360 | # will not generate output for the diagram. |
2361 | 2361 | |
2362 | -PLANTUML_JAR_PATH = | |
2362 | +PLANTUML_JAR_PATH = | |
2363 | 2363 | |
2364 | 2364 | # When using plantuml, the specified paths are searched for files specified by |
2365 | 2365 | # the !include statement in a plantuml block. |
2366 | 2366 | |
2367 | -PLANTUML_INCLUDE_PATH = | |
2367 | +PLANTUML_INCLUDE_PATH = | |
2368 | 2368 | |
2369 | 2369 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes |
2370 | 2370 | # that will be shown in the graph. If the number of nodes in a graph becomes |
@@ -39,7 +39,7 @@ class AbstractSpiMaster | ||
39 | 39 | * @param timeout_ms Timeout limit [mS] |
40 | 40 | * @return true if transfer complete, false if timeout |
41 | 41 | */ |
42 | - virtual bool Transfer(murasaki::AbstractSpiSlaveSpecifier * spi_spec, | |
42 | + virtual bool TransmitAndReceive(murasaki::AbstractSpiSlaveSpecifier * spi_spec, | |
43 | 43 | uint8_t * tx_data, |
44 | 44 | uint8_t * rx_data, |
45 | 45 | unsigned int size, |
@@ -49,7 +49,7 @@ class AbstractSpiMaster | ||
49 | 49 | * @param ptr Pointer to the control object. |
50 | 50 | * @return true if no error. |
51 | 51 | */ |
52 | - virtual bool TransferCompleteCallback(void * ptr) = 0; | |
52 | + virtual bool TransmitAndReceiveCompleteCallback(void * ptr) = 0; | |
53 | 53 | /** |
54 | 54 | * @brief Handling error report of device. |
55 | 55 | * @param ptr Pointer for generic use. Usually, points a struct of a device control |
@@ -26,6 +26,8 @@ namespace murasaki { | ||
26 | 26 | * |
27 | 27 | * The destructor deletes the task. |
28 | 28 | * Releasing thask from all the resources ( ex: semaphore ) before deleting, is the responsibility of the programmer. |
29 | + * | |
30 | + * Base on the description at http://idken.net/posts/2017-02-01-freertos_task_cpp/ | |
29 | 31 | * @ingroup MURASAKI_ABSTRACT_GROUP |
30 | 32 | */ |
31 | 33 | class AbstractTask |
@@ -39,7 +39,7 @@ SpiMaster::~SpiMaster() | ||
39 | 39 | |
40 | 40 | } |
41 | 41 | |
42 | -bool SpiMaster::Transfer(murasaki::AbstractSpiSlaveSpecifier* spi_spec, | |
42 | +bool SpiMaster::TransmitAndReceive(murasaki::AbstractSpiSlaveSpecifier* spi_spec, | |
43 | 43 | uint8_t* tx_data, |
44 | 44 | uint8_t* rx_data, |
45 | 45 | unsigned int size, |
@@ -87,7 +87,7 @@ bool SpiMaster::Transfer(murasaki::AbstractSpiSlaveSpecifier* spi_spec, | ||
87 | 87 | |
88 | 88 | } |
89 | 89 | |
90 | -bool SpiMaster::TransferCompleteCallback(void* ptr) | |
90 | +bool SpiMaster::TransmitAndReceiveCompleteCallback(void* ptr) | |
91 | 91 | { |
92 | 92 | MURASAKI_ASSERT(nullptr != ptr) |
93 | 93 |
@@ -18,7 +18,6 @@ | ||
18 | 18 | |
19 | 19 | namespace murasaki { |
20 | 20 | /** |
21 | - * \ingroup MURASAKI_GROUP | |
22 | 21 | * @brief Thread safe, blocking IO. Encapsulating SPI master. Based on STM32 HAL driver and FreeRTOS |
23 | 22 | * \details |
24 | 23 | * The SpiMaster class is the wrapper of the SPI controller. To use the SpiMaster class, |
@@ -35,10 +34,10 @@ namespace murasaki { | ||
35 | 34 | * \code |
36 | 35 | * void HAL_SPI_TxRxCpltCallback (SPI_HandleTypeDef * hspi) |
37 | 36 | * { |
38 | - * my_spi3->TransferCompleteCallback(hspi); | |
37 | + * my_spi3->TransmitAndReceiveCompleteCallback(hspi); | |
39 | 38 | * } |
40 | 39 | * \endcode |
41 | - * todo | |
40 | + * | |
42 | 41 | * Where HAL_SPI_TxRxCpltCallback is a predefined name of the SPI interrupt handler. |
43 | 42 | * This is invoked by system whenever a interrupt baed SPI transmission is complete. |
44 | 43 | * Becuase the default function is weakly bound, above definition will overwride the |
@@ -51,13 +50,14 @@ namespace murasaki { | ||
51 | 50 | * |
52 | 51 | * Once the instance and callbacks are correctly prepared, we can use the Transfer member function. |
53 | 52 | * |
54 | - * The @ref SpiMaster::Transfer() member function is a blocking function. A programmer can specify the | |
53 | + * The @ref SpiMaster::TransmitAndReceive() member function is a blocking function. A programmer can specify the | |
55 | 54 | * timeout by timeout_ms parameter. By default, this parameter is set by kwmsIndefinitely |
56 | 55 | * which specifes never time out. |
57 | 56 | * |
58 | 57 | * |
59 | 58 | * Both methods can be called from only the task context. If these are called in the ISR |
60 | 59 | * context, the result is unknown. |
60 | + * @ingroup MURASAKI_GROUP | |
61 | 61 | */ |
62 | 62 | class SpiMaster : public AbstractSpiMaster |
63 | 63 | { |
@@ -83,7 +83,7 @@ class SpiMaster : public AbstractSpiMaster | ||
83 | 83 | * from the spi_spec. And then, assert the chips elect through the spi_spec during the |
84 | 84 | * data transfer. |
85 | 85 | */ |
86 | - virtual bool Transfer(murasaki::AbstractSpiSlaveSpecifier * spi_spec, | |
86 | + virtual bool TransmitAndReceive(murasaki::AbstractSpiSlaveSpecifier * spi_spec, | |
87 | 87 | uint8_t * tx_data, |
88 | 88 | uint8_t * rx_data, |
89 | 89 | unsigned int size, |
@@ -93,7 +93,7 @@ class SpiMaster : public AbstractSpiMaster | ||
93 | 93 | * @param ptr Pointer to the control object. |
94 | 94 | * @return true if no error. |
95 | 95 | */ |
96 | - virtual bool TransferCompleteCallback(void * ptr); | |
96 | + virtual bool TransmitAndReceiveCompleteCallback(void * ptr); | |
97 | 97 | /** |
98 | 98 | * @brief Error handling |
99 | 99 | * @param ptr Pointer to I2C_HandleTypeDef struct. |