Skip to content

Commit e11df74

Browse files
committed
Set README.md as mainpage of doxygen document.
To allow doxygen link the class name inside README.md with class explanation, Remove the explicit link to the sub-md files inside README.md
1 parent 3391b4c commit e11df74

7 files changed

Lines changed: 11 additions & 64 deletions

File tree

Doxyfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -943,7 +943,7 @@ WARN_LOGFILE =
943943
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
944944
# Note: If this tag is empty the current directory is searched.
945945

946-
INPUT = src
946+
INPUT = src README.md
947947

948948
# This tag can be used to specify the character encoding of the source files
949949
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1153,7 +1153,7 @@ FILTER_SOURCE_PATTERNS =
11531153
# (index.html). This can be useful if you have a project on for instance GitHub
11541154
# and want to reuse the introduction page also for the doxygen output.
11551155

1156-
USE_MDFILE_AS_MAINPAGE =
1156+
USE_MDFILE_AS_MAINPAGE = README.md
11571157

11581158
# The Fortran standard specifies that for fixed formatted Fortran code all
11591159
# characters from position 72 are to be considered as comment. A common

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# Raspberry Pi Pico Driver class collection
2-
A Collection of the Raspberry Pi [Pico](https://www.raspberrypi.com/products/raspberry-pi-pico/)/[Pico2](https://www.raspberrypi.com/products/raspberry-pi-pico-2/) classes. Also, the [SDK API](https://www.raspberrypi.com/documentation/pico-sdk/hardware.html#group_sm_config_1gaed7a6e7dc4f1979c7c62e4773df8c79b) wrapper class is provided.
2+
A Collection of the Raspberry Pi [Pico](https://www.raspberrypi.com/products/raspberry-pi-pico/)/[Pico2](https://www.raspberrypi.com/products/raspberry-pi-pico-2/) classes. Also, a [SDK API](https://www.raspberrypi.com/documentation/pico-sdk/hardware.html#group_sm_config_1gaed7a6e7dc4f1979c7c62e4773df8c79b) wrapper class is provided.
33

4-
[HTML documentation](https://suikan4github.github.io/rpp_driver/) is available.
4+
An online [HTML documentation](https://suikan4github.github.io/rpp_driver/) is available for the details.
55

66
# Details
77
This class collection ( or class library ) encapsule the certain data inside class. And it also allows you to use the dependency-injection inside your project. So, you can test your code with [Google Test](https://github.com/google/googletest) before testing on the target hardware.
88

99
These classes are provided in this version.
1010

11-
| class | Description |
12-
|--------------------------------- |----------------------------- |
13-
| ::rpp_driver::[SdkWrapper](docs/sdkwrapper.md) | Wrapper class of Pico SDK |
14-
| ::rpp_driver::[GpioBasic](docs/gpiobasic.md) | Basic GPIO controller |
15-
| ::rpp_driver::[I2cMaster](docs/i2cmaster.md) | I2C Master controller |
16-
| ::rpp_driver::[I2sSlaveDuplex](docs/i2sslaveduplex.md) | Polling based PIO I2S driver |
17-
| ::rpp_driver::[Adau1361](docs/adau1361.md) | Audio CODEC driver |
11+
| class | Description |
12+
|--------------------------------- |----------------------------- |
13+
| ::rpp_driver::SdkWrapper | Wrapper class of Pico SDK |
14+
| ::rpp_driver::GpioBasic | Basic GPIO controller |
15+
| ::rpp_driver::I2cMaster | I2C Master controller |
16+
| ::rpp_driver::I2sSlaveDuplex | Polling based PIO I2S driver |
17+
| ::rpp_driver::Adau1361 | Audio CODEC driver |
1818

1919

2020
## How to obtain this project

docs/adau1361.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/gpiobasic.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/i2cmaster.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/i2sslaveduplex.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/sdkwrapper.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

0 commit comments

Comments
 (0)