Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc related fixups #421

Merged
merged 4 commits into from
Sep 25, 2020
Merged

doc related fixups #421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
26c133c
Fix documentation typo in qbrb.h
wferi Jul 30, 2020
98d3cf9
Fix section number in doxygen2man manual
wferi Sep 23, 2020
3605a8b
Point Doxygen to our examples
wferi Sep 23, 2020
d474f6f
No HTML documentation anymore
wferi Sep 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
man3
html
xml
*.dox
2 changes: 1 addition & 1 deletion docs/Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,4 +256,4 @@ endif
endif

clean-local:
rm -rf html man3 xml
rm -rf man3 xml
4 changes: 2 additions & 2 deletions docs/man.dox.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1221,14 +1221,14 @@ GENERATE_BUGLIST = NO
# that contain example code fragments that are included (see the \include
# command).

#EXAMPLE_PATH =
EXAMPLE_PATH = ../examples

# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank all
# files are included.

#EXAMPLE_PATTERNS =
EXAMPLE_PATTERNS = *.c

# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude commands
Expand Down
2 changes: 1 addition & 1 deletion doxygen2man/doxygen2man.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
.\" * Author: Christine Caulfield <[email protected]>
.\" *

.TH "DOXYGEN2MAN" "8" "2020-09-09" "" ""
.TH "DOXYGEN2MAN" "1" "2020-09-09" "" ""
.SH "NAME"
doxygen2man \- A tool to generate man pages from Doxygen XML files
.SH "SYNOPSIS"
Expand Down
2 changes: 1 addition & 1 deletion include/qb/qbrb.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ ssize_t qb_rb_chunks_used(qb_ringbuffer_t * rb);
ssize_t qb_rb_write_to_file(qb_ringbuffer_t * rb, int32_t fd);

/**
* Load the saved ring buffer from file into tempory memory.
* Load the saved ring buffer from file into temporary memory.
* @param fd file with saved ringbuffer data.
* @param flags same flags as passed into qb_rb_open()
* @return new ringbuffer instance
Expand Down