Skip to content

Commit ec88548

Browse files
committed
Modified Doxygen config file
1 parent 86842e0 commit ec88548

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

doc/Doxyfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ DOXYFILE_ENCODING = UTF-8
3232
# title of most generated pages and in a few other places.
3333
# The default value is: My Project.
3434

35-
PROJECT_NAME = "Switchtec Userspace"
35+
PROJECT_NAME = "Velocity Userspace"
3636

3737
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

4141
#PROJECT_NUMBER =
42-
@INCLUDE = "version"
42+
# @INCLUDE = "version"
4343

4444
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4545
# for a project that appears at the top of each page and should give viewer a
@@ -2102,7 +2102,7 @@ INCLUDE_FILE_PATTERNS =
21022102
# recursively expanded use the := operator instead of the = operator.
21032103
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
21042104

2105-
PREDEFINED =
2105+
PREDEFINED = __linux__
21062106

21072107
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
21082108
# tag can be used to specify a list of macro names that should be expanded. The

doc/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Introduction {#mainpage}
22
=================================
33

4-
This is the documentation for the Switchtec Userspace project. The userspace
4+
This is the documentation for the VelocityPCI Userspace project. The userspace
55
project consists of a command line interface (CLI) program which provides a
66
simple way to perform the most common maintenance operations. The CLI makes
7-
use of the userspace library (libswitchtec) which is also included in
7+
use of the userspace library which is also included in
88
this project and provides an API interface for all the commands the CLI can do
99
as well as interfaces for writing custom or other unimplemented commands.
1010
The library communicates with the kernel space drivers ([switchtec-kernel] for
@@ -32,11 +32,11 @@ will always have direct access to the GAS.
3232
[switchtec-kernel]: https://github.com/Microsemi/switchtec-kernel
3333

3434

35-
Switchtec Library
35+
VelocityPCI Library
3636
===================
3737

3838
To get started using the library you may refer to the examples provided
39-
in the examples folder of the switchtec-user repository. The APIs are also
39+
in the examples folder of the velocitypci-cli repository. The APIs are also
4040
documented herein. Basic functions to open a handle to a device and perform
4141
custom MRPC commands are documented in the [Device API]. Additional APIs
4242
for other functionality can be browsed in the [Modules] section.

lib/ini.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
*/
2929

3030
/**
31-
* @defgroup ini Functions
31+
* @defgroup ini Ini2bin Utility Functions
3232
* @brief ini2bin API functions
3333
*
3434
* These are functions used for converting INI file to BIN for OTP configuration record

0 commit comments

Comments
 (0)