Skip to content

Commit c4cdd42

Browse files
committed
Working on Jenkins build configuration
* Add an expanded Doxyfile (Linux with GCC) * Some README updates, still incomplete
1 parent 9e55465 commit c4cdd42

File tree

3 files changed

+43
-7
lines changed

3 files changed

+43
-7
lines changed

README

+7-6
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,19 @@ this distribution.
1010

1111
This repository contains a set of C header (include) files
1212
extracted from the development branch of EPICS Base, along
13-
with enough of the EPICS Build system to be able to run
14-
doxygen against those header files.
13+
with a configuration file for Doxygen to tell it how to
14+
process those header files.
1515

1616
Every GitHub pull-request (and subsequent commit to that
1717
branch) made against this repository will be processed by
18-
Jenkins and the results made available on a website where
18+
Doxygen and the results made available on a website where
1919
they can be checked - a link to the results from your pull
2020
request will be sent to you by email when the processing
2121
is finished. If the output wasn't quite what you wanted it
22-
to look like, fix your Doxygen annotations, commit them
23-
and commit and push to the same branch. Jenkins will redo
24-
the processing and send you another email when it's ready.
22+
to look like, fix your Doxygen annotations and commit and
23+
push them to your branch (or just commit them if you're
24+
working directly on Github). Doxygen will redo the
25+
processing and you'll get another email when it's ready.
2526

2627
...
2728

documentation/.gitignore

-1
This file was deleted.

documentation/Doxyfile

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Doxyfile 1.8.7
2+
3+
# This template is used to generate the doxygen config file for EPICS Base
4+
5+
# Project details
6+
PROJECT_NAME = "EPICS Base"
7+
PROJECT_NUMBER = 7.0.1.2
8+
9+
# Input paths
10+
INPUT = ../include
11+
RECURSIVE = YES
12+
STRIP_FROM_PATH = ../include
13+
INCLUDE_PATH = ../include \
14+
../include/compiler/gcc ../include/os/Linux
15+
16+
# Output paths
17+
HTML_OUTPUT = ../html/doxygen
18+
LATEX_OUTPUT = O.latex
19+
20+
# Input configuration
21+
TAB_SIZE = 8
22+
CASE_SENSE_NAMES = YES
23+
ENABLE_PREPROCESSING = YES
24+
MACRO_EXPANSION = YES
25+
EXPAND_ONLY_PREDEF = NO
26+
27+
# Output configuration
28+
QUIET = YES
29+
WARN_IF_UNDOCUMENTED = NO
30+
PAPER_TYPE = letter
31+
LATEX_BATCHMODE = YES
32+
ALWAYS_DETAILED_SEC = NO
33+
SORT_MEMBER_DOCS = NO
34+
BRIEF_MEMBER_DESC = YES
35+
REPEAT_BRIEF = NO
36+
EXTRACT_ALL = NO

0 commit comments

Comments
 (0)