sysmocom
/
openblt
11
0
Fork 0
Code Issues Pull Requests Releases Activity

Refs #560. Improved a few doxygen related configurations and switched to CHM-format for the default documentation generation. 

git-svn-id: https://svn.code.sf.net/p/openblt/code/trunk@534 5dc33758-31d5-4daf-9ae8-b24bf3d40d73
This commit is contained in:
Frank Voorburg 2018-07-05 10:38:28 +00:00
parent 7a4d7e8b84
commit dec51c8190
24 changed files with 31 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Doc/doxygen/DoxyfileBootCommander.bat
View File

@ -7,8 +7,8 @@
if exist ..\RM_BootCommander.pdf del ..\RM_BootCommander.pdf if exist ..\RM_BootCommander.pdf del ..\RM_BootCommander.pdf
if exist ..\RM_BootCommander.chm del ..\RM_BootCommander.chm if exist ..\RM_BootCommander.chm del ..\RM_BootCommander.chm
doxygen.exe DoxyfileBootCommander doxygen.exe DoxyfileBootCommander
call .\output\BootCommander\latex\make.bat :: call .\output\BootCommander\latex\make.bat
call copy .\output\BootCommander\latex\refman.pdf ..\RM_BootCommander.pdf :: call copy .\output\BootCommander\latex\refman.pdf ..\RM_BootCommander.pdf
:: Remove the comment on the next line to automatically open the generated PDF file :: Remove the comment on the next line to automatically open the generated PDF file
:: call start "C:\Program Files (x86)\Adobe\Reader 11.0\Reader\AcroRd32.exe" ..\RM_BootCommander.pdf :: call start "C:\Program Files (x86)\Adobe\Reader 11.0\Reader\AcroRd32.exe" ..\RM_BootCommander.pdf
:: Remove the comment on the next line to automatically open the generated CHM file :: Remove the comment on the next line to automatically open the generated CHM file

4
Doc/doxygen/DoxyfileLibOpenBLT.bat
View File

@ -7,8 +7,8 @@
if exist ..\RM_LibOpenBLT.pdf del ..\RM_LibOpenBLT.pdf if exist ..\RM_LibOpenBLT.pdf del ..\RM_LibOpenBLT.pdf
if exist ..\RM_LibOpenBLT.chm del ..\RM_LibOpenBLT.chm if exist ..\RM_LibOpenBLT.chm del ..\RM_LibOpenBLT.chm
doxygen.exe DoxyfileLibOpenBLT doxygen.exe DoxyfileLibOpenBLT
call .\output\LibOpenBLT\latex\make.bat :: call .\output\LibOpenBLT\latex\make.bat
call copy .\output\LibOpenBLT\latex\refman.pdf ..\RM_LibOpenBLT.pdf :: call copy .\output\LibOpenBLT\latex\refman.pdf ..\RM_LibOpenBLT.pdf
:: Remove the comment on the next line to automatically open the generated PDF file :: Remove the comment on the next line to automatically open the generated PDF file
:: call start "C:\Program Files (x86)\Adobe\Reader 11.0\Reader\AcroRd32.exe" ..\RM_LibOpenBLT.pdf :: call start "C:\Program Files (x86)\Adobe\Reader 11.0\Reader\AcroRd32.exe" ..\RM_LibOpenBLT.pdf
:: Remove the comment on the next line to automatically open the generated CHM file :: Remove the comment on the next line to automatically open the generated CHM file

4
Doc/doxygen/DoxyfileOpenBLT.bat
View File

@ -7,8 +7,8 @@
if exist ..\RM_OpenBLT.pdf del ..\RM_OpenBLT.pdf if exist ..\RM_OpenBLT.pdf del ..\RM_OpenBLT.pdf
if exist ..\RM_OpenBLT.chm del ..\RM_OpenBLT.chm if exist ..\RM_OpenBLT.chm del ..\RM_OpenBLT.chm
doxygen.exe DoxyfileOpenBLT doxygen.exe DoxyfileOpenBLT
call .\output\OpenBLT\latex\make.bat :: call .\output\OpenBLT\latex\make.bat
call copy .\output\OpenBLT\latex\refman.pdf ..\RM_OpenBLT.pdf :: call copy .\output\OpenBLT\latex\refman.pdf ..\RM_OpenBLT.pdf
:: Remove the comment on the next line to automatically open the generated PDF file :: Remove the comment on the next line to automatically open the generated PDF file
:: call start "C:\Program Files (x86)\Adobe\Reader 11.0\Reader\AcroRd32.exe" ..\RM_OpenBLT.pdf :: call start "C:\Program Files (x86)\Adobe\Reader 11.0\Reader\AcroRd32.exe" ..\RM_OpenBLT.pdf
:: Remove the comment on the next line to automatically open the generated CHM file :: Remove the comment on the next line to automatically open the generated CHM file

4
Doc/doxygen/DoxyfileSeedNKey.bat
View File

@ -7,8 +7,8 @@
if exist ..\RM_SeedNKey.pdf del ..\RM_SeedNKey.pdf if exist ..\RM_SeedNKey.pdf del ..\RM_SeedNKey.pdf
if exist ..\RM_SeedNKey.chm del ..\RM_SeedNKey.chm if exist ..\RM_SeedNKey.chm del ..\RM_SeedNKey.chm
doxygen.exe DoxyfileSeedNKey doxygen.exe DoxyfileSeedNKey
call .\output\SeedNKey\latex\make.bat :: call .\output\SeedNKey\latex\make.bat
call copy .\output\SeedNKey\latex\refman.pdf ..\RM_SeedNKey.pdf :: call copy .\output\SeedNKey\latex\refman.pdf ..\RM_SeedNKey.pdf
:: Remove the comment on the next line to automatically open the generated PDF file :: Remove the comment on the next line to automatically open the generated PDF file
:: call start "C:\Program Files (x86)\Adobe\Reader 11.0\Reader\AcroRd32.exe" ..\RM_SeedNKey.pdf :: call start "C:\Program Files (x86)\Adobe\Reader 11.0\Reader\AcroRd32.exe" ..\RM_SeedNKey.pdf
:: Remove the comment on the next line to automatically open the generated CHM file :: Remove the comment on the next line to automatically open the generated CHM file

2
Target/Demo/ARMCM0_STM32F0_Discovery_STM32F051_TrueStudio/Prog/prog.dox
View File

@ -1,6 +1,6 @@
/** /**
\defgroup Prog_ARMCM0_STM32F0_Discovery_STM32F051_TrueStudio User Program \defgroup Prog_ARMCM0_STM32F0_Discovery_STM32F051_TrueStudio User Program
\ingroup ARMCM0_ARMCM0_STM32F0_Discovery_STM32F051_TrueStudio \ingroup ARMCM0_STM32F0_Discovery_STM32F051_TrueStudio
\brief User Program. \brief User Program.
\details The intention of the demo user program is two-fold. (1) To test the \details The intention of the demo user program is two-fold. (1) To test the
bootloader, you need some sort of firmware to see if you can perform a bootloader, you need some sort of firmware to see if you can perform a

2
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_GCC/Boot/blt_conf.h
View File

@ -1,7 +1,7 @@
/************************************************************************************//** /************************************************************************************//**
* \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Boot\blt_conf.h * \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Boot\blt_conf.h
* \brief Bootloader configuration header file. * \brief Bootloader configuration header file.
* \ingroup Boot_ARMCM3_STM32F2_Olimex_STM32F207_GCC * \ingroup Boot_ARMCM3_STM32F2_Olimex_STM32P207_GCC
* \internal * \internal
*---------------------------------------------------------------------------------------- *----------------------------------------------------------------------------------------
* C O P Y R I G H T * C O P Y R I G H T

4
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_GCC/Boot/boot.dox
View File

@ -1,7 +1,7 @@
/** /**
\defgroup Boot_ARMCM3_STM32F2_Olimex_STM32F207_GCC Bootloader \defgroup Boot_ARMCM3_STM32F2_Olimex_STM32P207_GCC Bootloader
\brief Bootloader. \brief Bootloader.
\ingroup ARMCM3_STM32F2_Olimex_STM32F207_GCC \ingroup ARMCM3_STM32F2_Olimex_STM32P207_GCC
*/ */

2
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_GCC/Boot/hooks.c
View File

@ -1,7 +1,7 @@
/************************************************************************************//** /************************************************************************************//**
* \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Boot\hooks.c * \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Boot\hooks.c
* \brief Bootloader callback source file. * \brief Bootloader callback source file.
* \ingroup Boot_ARMCM3_STM32F2_Olimex_STM32F207_GCC * \ingroup Boot_ARMCM3_STM32F2_Olimex_STM32P207_GCC
* \internal * \internal
*---------------------------------------------------------------------------------------- *----------------------------------------------------------------------------------------
* C O P Y R I G H T * C O P Y R I G H T

2
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_GCC/Boot/led.c
View File

@ -1,7 +1,7 @@
/************************************************************************************//** /************************************************************************************//**
* \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Boot\led.c * \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Boot\led.c
* \brief LED driver source file. * \brief LED driver source file.
* \ingroup Boot_ARMCM3_STM32F2_Olimex_STM32F207_GCC * \ingroup Boot_ARMCM3_STM32F2_Olimex_STM32P207_GCC
* \internal * \internal
*---------------------------------------------------------------------------------------- *----------------------------------------------------------------------------------------
* C O P Y R I G H T * C O P Y R I G H T

2
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_GCC/Boot/led.h
View File

@ -1,7 +1,7 @@
/************************************************************************************//** /************************************************************************************//**
* \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Boot\led.h * \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Boot\led.h
* \brief LED driver header file. * \brief LED driver header file.
* \ingroup Boot_ARMCM3_STM32F2_Olimex_STM32F207_GCC * \ingroup Boot_ARMCM3_STM32F2_Olimex_STM32P207_GCC
* \internal * \internal
*---------------------------------------------------------------------------------------- *----------------------------------------------------------------------------------------
* C O P Y R I G H T * C O P Y R I G H T

2
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_GCC/Boot/main.c
View File

@ -1,7 +1,7 @@
/************************************************************************************//** /************************************************************************************//**
* \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Boot\main.c * \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Boot\main.c
* \brief Bootloader application source file. * \brief Bootloader application source file.
* \ingroup Boot_ARMCM3_STM32F2_Olimex_STM32F207_GCC * \ingroup Boot_ARMCM3_STM32F2_Olimex_STM32P207_GCC
* \internal * \internal
*---------------------------------------------------------------------------------------- *----------------------------------------------------------------------------------------
* C O P Y R I G H T * C O P Y R I G H T

2
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_GCC/Prog/boot.c
View File

@ -1,7 +1,7 @@
/************************************************************************************//** /************************************************************************************//**
* \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Prog\boot.c * \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Prog\boot.c
* \brief Demo program bootloader interface source file. * \brief Demo program bootloader interface source file.
* \ingroup Prog_ARMCM3_STM32F2_Olimex_STM32F207_GCC * \ingroup Prog_ARMCM3_STM32F2_Olimex_STM32P207_GCC
* \internal * \internal
*---------------------------------------------------------------------------------------- *----------------------------------------------------------------------------------------
* C O P Y R I G H T * C O P Y R I G H T

2
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_GCC/Prog/boot.h
View File

@ -1,7 +1,7 @@
/************************************************************************************//** /************************************************************************************//**
* \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Prog\boot.h * \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Prog\boot.h
* \brief Demo program bootloader interface header file. * \brief Demo program bootloader interface header file.
* \ingroup Prog_ARMCM3_STM32F2_Olimex_STM32F207_GCC * \ingroup Prog_ARMCM3_STM32F2_Olimex_STM32P207_GCC
* \internal * \internal
*---------------------------------------------------------------------------------------- *----------------------------------------------------------------------------------------
* C O P Y R I G H T * C O P Y R I G H T

2
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_GCC/Prog/header.h
View File

@ -1,7 +1,7 @@
/************************************************************************************//** /************************************************************************************//**
* \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Prog\header.h * \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Prog\header.h
* \brief Generic header file. * \brief Generic header file.
* \ingroup Prog_ARMCM3_STM32F2_Olimex_STM32F207_GCC * \ingroup Prog_ARMCM3_STM32F2_Olimex_STM32P207_GCC
* \internal * \internal
*---------------------------------------------------------------------------------------- *----------------------------------------------------------------------------------------
* C O P Y R I G H T * C O P Y R I G H T

2
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_GCC/Prog/led.c
View File

@ -1,7 +1,7 @@
/************************************************************************************//** /************************************************************************************//**
* \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Prog\led.c * \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Prog\led.c
* \brief LED driver source file. * \brief LED driver source file.
* \ingroup Prog_ARMCM3_STM32F2_Olimex_STM32F207_GCC * \ingroup Prog_ARMCM3_STM32F2_Olimex_STM32P207_GCC
* \internal * \internal
*---------------------------------------------------------------------------------------- *----------------------------------------------------------------------------------------
* C O P Y R I G H T * C O P Y R I G H T

2
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_GCC/Prog/led.h
View File

@ -1,7 +1,7 @@
/************************************************************************************//** /************************************************************************************//**
* \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Prog\led.h * \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Prog\led.h
* \brief LED driver header file. * \brief LED driver header file.
* \ingroup Prog_ARMCM3_STM32F2_Olimex_STM32F207_GCC * \ingroup Prog_ARMCM3_STM32F2_Olimex_STM32P207_GCC
* \internal * \internal
*---------------------------------------------------------------------------------------- *----------------------------------------------------------------------------------------
* C O P Y R I G H T * C O P Y R I G H T

2
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_GCC/Prog/main.c
View File

@ -1,7 +1,7 @@
/************************************************************************************//** /************************************************************************************//**
* \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Prog\main.c * \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Prog\main.c
* \brief Demo program application source file. * \brief Demo program application source file.
* \ingroup Prog_ARMCM3_STM32F2_Olimex_STM32F207_GCC * \ingroup Prog_ARMCM3_STM32F2_Olimex_STM32P207_GCC
* \internal * \internal
*---------------------------------------------------------------------------------------- *----------------------------------------------------------------------------------------
* C O P Y R I G H T * C O P Y R I G H T

4
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_GCC/Prog/prog.dox
View File

@ -1,6 +1,6 @@
/** /**
\defgroup Prog_ARMCM3_STM32F2_Olimex_STM32F207_GCC User Program \defgroup Prog_ARMCM3_STM32F2_Olimex_STM32P207_GCC User Program
\ingroup ARMCM3_STM32F2_Olimex_STM32F207_GCC \ingroup ARMCM3_STM32F2_Olimex_STM32P207_GCC
\brief User Program. \brief User Program.
\details The intention of the demo user program is two-fold. (1) To test the \details The intention of the demo user program is two-fold. (1) To test the
bootloader, you need some sort of firmware to see if you can perform a bootloader, you need some sort of firmware to see if you can perform a

2
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_GCC/Prog/timer.c
View File

@ -1,7 +1,7 @@
/************************************************************************************//** /************************************************************************************//**
* \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Prog\timer.c * \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Prog\timer.c
* \brief Timer driver source file. * \brief Timer driver source file.
* \ingroup Prog_ARMCM3_STM32F2_Olimex_STM32F207_GCC * \ingroup Prog_ARMCM3_STM32F2_Olimex_STM32P207_GCC
* \internal * \internal
*---------------------------------------------------------------------------------------- *----------------------------------------------------------------------------------------
* C O P Y R I G H T * C O P Y R I G H T

2
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_GCC/Prog/timer.h
View File

@ -1,7 +1,7 @@
/************************************************************************************//** /************************************************************************************//**
* \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Prog\timer.h * \file Demo\ARMCM3_STM32F2_Olimex_STM32P207_GCC\Prog\timer.h
* \brief Timer driver header file. * \brief Timer driver header file.
* \ingroup Prog_ARMCM3_STM32F2_Olimex_STM32F207_GCC * \ingroup Prog_ARMCM3_STM32F2_Olimex_STM32P207_GCC
* \internal * \internal
*---------------------------------------------------------------------------------------- *----------------------------------------------------------------------------------------
* C O P Y R I G H T * C O P Y R I G H T

2
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_GCC/demo.dox
View File

@ -1,5 +1,5 @@
/** /**
\defgroup ARMCM3_STM32F2_Olimex_STM32F207_GCC Demo for Olimex STM32-P207/GCC \defgroup ARMCM3_STM32F2_Olimex_STM32P207_GCC Demo for Olimex STM32-P207/GCC
\ingroup Demos \ingroup Demos
\brief Preconfigured programs for the Olimex STM32-P207 and the GCC compiler. \brief Preconfigured programs for the Olimex STM32-P207 and the GCC compiler.
\details For detailed getting started instructions, refer to: \details For detailed getting started instructions, refer to:

2
Target/Demo/ARMCM3_STM32F2_Olimex_STM32P207_IAR/demo.dox
View File

@ -1,5 +1,5 @@
/** /**
\defgroup ARMCM3_STM32F2_Olimex_STM32F207_IAR Demo for Olimex STM32-P207/IAR \defgroup ARMCM3_STM32F2_Olimex_STM32P207_IAR Demo for Olimex STM32-P207/IAR
\ingroup Demos \ingroup Demos
\brief Preconfigured programs for the Olimex STM32-P207 and the IAR Embedded Workbench. \brief Preconfigured programs for the Olimex STM32-P207 and the IAR Embedded Workbench.
\details For detailed getting started instructions, refer to: \details For detailed getting started instructions, refer to:

2
Target/Demo/ARMCM4_STM32F3_Nucleo_F303K8_IAR/Boot/boot.dox
View File

@ -1,5 +1,5 @@
/** /**
\defgroup Boot_ARMCM4_STM32F3_Nucleo_F303K8_IAR \defgroup Boot_ARMCM4_STM32F3_Nucleo_F303K8_IAR Bootloader
\brief Bootloader. \brief Bootloader.
\ingroup ARMCM4_STM32F3_Nucleo_F303K8_IAR \ingroup ARMCM4_STM32F3_Nucleo_F303K8_IAR
*/ */

4
Target/Demo/ARMCM4_STM32L4_Nucleo_L476RG_GCC/Prog/prog.dox
View File

@ -1,6 +1,6 @@
/** /**
\defgroup Prog_ARMCM4_STM32L4_Nucleo_L476RG_TrueStudio User Program \defgroup Prog_ARMCM4_STM32L4_Nucleo_L476RG_GCC User Program
\ingroup ARMCM4_STM32L4_Nucleo_L476RG_TrueStudio \ingroup ARMCM4_STM32L4_Nucleo_L476RG_GCC
\brief User Program. \brief User Program.
\details The intention of the demo user program is two-fold. (1) To test the \details The intention of the demo user program is two-fold. (1) To test the
bootloader, you need some sort of firmware to see if you can perform a bootloader, you need some sort of firmware to see if you can perform a