mirror
/
libx52
mirror of https://github.com/nirenjan/libx52.git
1
0
Fork 0
Code Releases Wiki Activity

Add documentation for x52bugreport

reverse-scroll
nirenjan 2021-10-11 09:54:27 -07:00
parent 2cc3cc5bfe
commit 41be44cc94
3 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile.am
View File

@ -62,7 +62,7 @@ all-local: docs/.stamp
clean-local: clean-local:
rm -rf $(top_builddir)/docs rm -rf $(top_builddir)/docs
man1_MANS = docs/man/man1/x52cli.1 man1_MANS = docs/man/man1/x52cli.1 docs/man/man1/x52bugreport.1
$(man1_MANS): docs/.stamp $(man1_MANS): docs/.stamp
# Install Doxygen generated HTML documentation and manpages # Install Doxygen generated HTML documentation and manpages

2
bugreport/Makefile.am
View File

@ -20,3 +20,5 @@ x52bugreport_LDFLAGS = \
$(WARN_LDFLAGS) $(WARN_LDFLAGS)
x52bugreport_LDADD = libx52io.la x52bugreport_LDADD = libx52io.la
EXTRA_DIST += bugreport/bugreport.dox

22
bugreport/bugreport.dox 100644
View File

@ -0,0 +1,22 @@
/**
@page x52bugreport System information utility for bug reports
\htmlonly
<b>x52bugreport</b> - System information utility for bug reports
\endhtmlonly
# SYNOPSIS
<tt>\b x52bugreport</tt>
# DESCRIPTION
\b x52bugreport is a utility that collects and reports information on the
current system and build environment. The reported information can be provided
when raising a bug report on https://github.com/nirenjan/libx52/issues.
# USAGE
\b x52bugreport
*/