mirror of https://github.com/rusefi/ChibiOS.git
Documentation improvements.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@10094 35acf78f-673a-0410-8e92-d51de3d6d3f4
This commit is contained in:
Giovanni Di Sirio
parent
3b2070d6e7
commit
6e5e2aa9ac
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,8 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Refresh" content="0; URL=html/index.html">
|
||||
</head>
|
||||
<body>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
del html\*.* /Q
|
||||
doxygen Doxyfile_html
|
||||
del html\*.md5
|
||||
del html\*.map
|
||||
pause
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
#!/bin/bash
|
||||
rm html/*
|
||||
doxygen Doxyfile_html
|
||||
rm html/*.md5
|
||||
rm html/*.map
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
/*
|
||||
ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio.
|
||||
|
||||
This file is part of ChibiOS.
|
||||
|
||||
ChibiOS is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
ChibiOS is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @mainpage Introduction
|
||||
* @author Giovanni Di Sirio (gdisirio@users.sourceforge.net).
|
||||
*
|
||||
* <h2>Features</h2>
|
||||
* - Hardware Abstraction Layer (HAL) supporting numerous high level device
|
||||
* drivers abstracting common features in modern MCUs.
|
||||
* - Driver models for: ADC, CAN, DAC, EXT, GPT, I2C, I2S, ICU, MAC, MMC, PAL,
|
||||
* PWM, RTC, SDC, Serial, UART, USB, USB-CDC, SPI, ST, WDG.
|
||||
* - Abstraction of streams.
|
||||
* - Abstraction of block devices.
|
||||
* - The drivers can be ported to virtually any MCU architecture thanks to
|
||||
* an high level API.
|
||||
* - The HAL can be used with or without an RTOS.
|
||||
* - The HAL can be adapted to any reasonable RTOS thanks to an Operating
|
||||
* System Abstraction Layer (OSAL). ChibiOS/RT and ChibiOS/NIL are supported
|
||||
* out of the box.
|
||||
* .
|
||||
*/
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
*** Documentation build procedure ***
|
||||
|
||||
The following software must be installed:
|
||||
- Doxygen 1.7.4 or later.
|
||||
- Graphviz 2.26.3 or later. The ./bin directory must be specified in the path
|
||||
in order to make Graphviz accessible by Doxygen.
|
||||
|
||||
Build procedure:
|
||||
- Run Doxywizard.
|
||||
- Load ./docs/Doxyfile_html or ./docs/Doxyfile_chm from Doxywizard.
|
||||
- Start.
|
||||
|
|
@ -1,11 +1,10 @@
|
|||
*** Documentation build procedure ***
|
||||
|
||||
The following software must be installed:
|
||||
- Doxygen 1.7.4 or later.
|
||||
- Doxygen 1.8.8 or later.
|
||||
- Graphviz 2.26.3 or later. The ./bin directory must be specified in the path
|
||||
in order to make Graphviz accessible by Doxygen.
|
||||
|
||||
Build procedure:
|
||||
- Run Doxywizard.
|
||||
- Load ./docs/Doxyfile_html or ./docs/Doxyfile_chm from Doxywizard.
|
||||
- Start.
|
||||
- Run: doxygen Doxyfile_html or Doxyfile_chm
|
||||
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
*** Documentation build procedure ***
|
||||
|
||||
The following software must be installed:
|
||||
- Doxygen 1.7.4 or later.
|
||||
- Graphviz 2.26.3 or later. The ./bin directory must be specified in the path
|
||||
in order to make Graphviz accessible by Doxygen.
|
||||
|
||||
Build procedure:
|
||||
- Run Doxywizard.
|
||||
- Load ./docs/Doxyfile_html or ./docs/Doxyfile_chm from Doxywizard.
|
||||
- Start.
|
||||
Loading…
Reference in New Issue