├── .gitmodules
├── tests
├── build
│ └── bin
│ │ └── test
└── test.c
├── .travis.yml
├── .gitignore
├── .github
└── workflows
│ └── RunTests.yml
├── Makefile
├── README.md
├── lib
└── ring.h
├── Src
├── ring.h
└── ring.c
├── LICENSE
└── doxyConfig
/.gitmodules:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/tests/build/bin/test:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/magiczny-kacper/RingBuffer/HEAD/tests/build/bin/test
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: C
2 | compiler: gcc
3 | script:
4 | - make clean
5 | - make all
6 | after_success:
7 | - bash <(curl -s https://codecov.io/bash)
8 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Prerequisites
2 | *.d
3 |
4 | # Object files
5 | *.o
6 | *.ko
7 | *.obj
8 | *.elf
9 |
10 | # Linker output
11 | *.ilk
12 | *.map
13 | *.exp
14 |
15 | # Precompiled Headers
16 | *.gch
17 | *.pch
18 |
19 | # Libraries
20 | *.lib
21 | *.a
22 | *.la
23 | *.lo
24 |
25 | # Shared objects (inc. Windows DLLs)
26 | *.dll
27 | *.so
28 | *.so.*
29 | *.dylib
30 |
31 | # Executables
32 | *.exe
33 | *.out
34 | *.app
35 | *.i*86
36 | *.x86_64
37 | *.hex
38 |
39 | # Debug files
40 | *.dSYM/
41 | *.su
42 | *.idb
43 | *.pdb
44 |
45 | # Kernel Module Compile Results
46 | *.mod*
47 | *.cmd
48 | .tmp_versions/
49 | modules.order
50 | Module.symvers
51 | Mkfile.old
52 | dkms.conf
53 |
54 | build/bin/*
55 | build/obj/*
56 |
57 | tests/build/bin/*
58 | tests/build/obj/*
--------------------------------------------------------------------------------
/.github/workflows/RunTests.yml:
--------------------------------------------------------------------------------
1 | name: BuildWrokflow
2 |
3 | on:
4 | pull_request:
5 | branches: [ master_v1 ]
6 | workflow_dispatch:
7 |
8 | jobs:
9 | build:
10 | runs-on: ubuntu-latest
11 |
12 | steps:
13 | - uses: actions/checkout@v2
14 | - name: Install criterion
15 | run: |
16 | wget -qO- https://github.com/Snaipe/Criterion/releases/download/v2.3.3/criterion-v2.3.3-linux-x86_64.tar.bz2 | tar -xjvf -
17 | sudo cp -a criterion-v2.3.3/lib/. /usr/lib
18 | sudo cp -a criterion-v2.3.3/include/. /usr/include
19 | - name: Init
20 | run: make init
21 | - name: Clean
22 | run: make clean_all
23 | - name: Run unit tests, generate docs
24 | run: make all
25 | - name: Doxygen Action
26 | uses: mattnotmitt/doxygen-action@v1.1.0
27 | with:
28 | doxyfile-path: "./doxyConfig"
29 | - name: Deploy to GitHub Pages
30 | uses: JamesIves/github-pages-deploy-action@4.1.4
31 | with:
32 | branch: docs
33 | folder: docs
34 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | CC=gcc
2 | CFLAGS=-c -g -Wall
3 |
4 | AR=ar
5 | ARFLAGS=-rc
6 |
7 | # Source directory
8 | SRC=Src
9 | TEST_SRC=tests
10 |
11 | OBJ=build/obj
12 | TEST_OBJ=tests/build/obj
13 |
14 | # Returns all files with *.c extension from $(SRC) directory.
15 | SRCS=$(wildcard $(SRC)/*.c)
16 | TEST_SRCS=$(wildcard $(TEST_SRC)/*.c)
17 |
18 | # This takes $(SRCS) as input,
19 | # if the $(SRC)/%.c pattern is matched,
20 | # then it is changed to $(OBJ)/%.o and added to return value.
21 | # This way, it converts the list of C files specified in SRCS to list of .o
22 | # files, to build object files.
23 | OBJS=$(patsubst $(SRC)/%.c, $(OBJ)/%.o, $(SRCS))
24 | TEST_OBJS=$(patsubst $(TEST_SRC)/%.c, $(TEST_OBJ)/%.o, $(TEST_SRCS))
25 |
26 | BINDIR=build/bin
27 | BINNAME=ring
28 | BIN=$(BINDIR)/lib$(BINNAME)
29 |
30 | TEST_BINDIR=tests/build/bin
31 | TEST_BINNAME=test
32 | TEST_BIN=$(TEST_BINDIR)/$(TEST_BINNAME)
33 |
34 | LIBDIR=lib
35 |
36 | TEST_LD_FLAGS=-I$(LIBDIR) -L$(LIBDIR) -l$(BINNAME) -lcriterion
37 | STATICLIB=$(BIN).a
38 |
39 | CRITERION_FLAGS=--verbose --full-stats
40 |
41 | init:
42 | mkdir -p $(TEST_BINDIR)
43 | mkdir -p $(TEST_OBJ)
44 | mkdir -p $(BINDIR)
45 | mkdir -p $(OBJ)
46 |
47 | all: lib test
48 |
49 | lib: $(BIN)
50 | cp $(BINDIR)/* $(LIBDIR)/
51 | cp $(SRC)/*.h $(LIBDIR)/
52 |
53 | # Compiles static library
54 | $(BIN): $(OBJS)
55 | # $(CC) $(CFLAGS) $(OBJS) -o $@
56 | $(AR) $(ARFLAGS) $(BIN).a $(OBJS)
57 |
58 | # Creates object files from c files
59 | $(OBJ)/%.o: $(SRC)/%.c
60 | $(CC) $(CFLAGS) -c $< -o $@
61 |
62 | test: lib $(TEST_BIN)
63 | $(info Running unit tests...)
64 | $(TEST_BIN) $(CRITERION_FLAGS)
65 | # $(CC) $(TEST_CFLAGS) -c tests/test.c -o tests/test.o
66 |
67 | $(TEST_BIN): $(TEST_OBJS)
68 | $(CC) $(TEST_CFLAGS) $(TEST_OBJS) -o $@ $(TEST_LD_FLAGS)
69 |
70 | $(TEST_OBJ)/%.o: $(TEST_SRC)/%.c
71 | $(CC) $(TEST_CFLAGS) -c $< -o $@ $(TEST_LD_FLAGS)
72 |
73 | cicd_run:
74 | $(error Thi is supposed to be run by CI/CD system. Run unit tests, and\
75 | generate docs if tests passed.)
76 |
77 | # To assure it will work
78 | .PHONY: clean
79 | # Removes compiled files
80 | clean:
81 | $(RM) -rf $(BINDIR)/* $(OBJ)/*
82 |
83 | .PHONY: clean_test
84 | clean_test:
85 | $(RM) -rf $(TEST_BINDIR)/* $(TEST_OBJ)/*
86 |
87 | .PHONY: clean_all
88 | clean_all: clean clean_test
89 |
90 | # To assure it will work, whether docs directory is present or not
91 | .PHONY: docs
92 | docs:
93 | ifeq (, $(shell which doxygen))
94 | $(error No doxygen installed. Cannot generate docs.)
95 | endif
96 | $(RM) -rf docs
97 | doxygen doxyConfig
98 |
99 | # Prints all .h and .c files
100 | print: $(SRCS) $(wildcard $(SRC)/*.h) $(TEST_SRCS)
101 | ls -la $?
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # RingBuffer
2 | 
3 | [](https://www.gnu.org/licenses/gpl-3.0)
4 |
5 | ### Short description
6 | My ring buffer implementation, for embedde applications. Tested on STM32L1
7 | STM32F3, STM32F4 and PIC18F platforms. Includes unit tests.
8 | * Src - folder containing source code.
9 | * Unit_test - Unit tests source files.
10 | * Docs - Documentation files.
11 | * unity - Unit tests framework.
12 |
13 | # Usage
14 | This part explains basic usage of this ring buffer library.
15 | ## Initialization
16 | If user uses fixed size arrays mode, function `RingInit` takes only one argument,
17 | which is pointer to `RingBuffer_t` structure.
18 | If variable arrays mode is used, user should declare array of type `uint8_t`,
19 | with desired size. This array and its size should be given as parameters to
20 | `RingInit` function.
21 | If inputs parameters given are valid, function should return `OK`. Now the
22 | buffer is ready to use.
23 | Note: there could be more than one buffer declared.
24 | ## Writing to buffer
25 | There are two functions used to write data to buffer. These are:
26 | * `RingWriteByte` - used to write only one byte to buffer. As parameters,
27 | function takse pointer to buffer handler, and as second argument, one byte of
28 | data to be written.
29 | * `RingWriteMultipleBytes` - used to write one or more bytes to buffer. First
30 | parameter is pointer to buffer handler, second is pointer to data to be written,
31 | and the third is length of data to write.
32 | Both functions return `OK` if write was succesfull, or `NO_PLACE` if there was
33 | not enough space in buffer, or `NO_PTR` if null pointer was given as an argument.
34 | ## Reading from buffer
35 | As before, to read from buffer, there are two functions provided.
36 | * `RingReadByte` - used to read one byte from given buffer.
37 | * `RingReadMultipleBytes` - used to read one or more bytes from buffer.
38 | ## Additional functions
39 | * `RingGetHead` - returns next array index to write.
40 | * `RingGetTail` - returns index of the next element from array that will be read.
41 | * `RingGetMaxSize` - returns buffer size in bytes.
42 | * `RingGetSpace` - retuns free spce in buffer.
43 | * `RingGetDataCnt` - returns number of unread bytes in buffer.
44 | * `RingGetLastElement` - returns last element from buffer without taking it from
45 | buffer. Could be usable for example when using as UART receive buffer, for
46 | waiting if received data string was terminated with specific value.
47 | # To do:
48 | - [x] Add makefile for unit tests
49 | - [x] Add unit tests files
50 | - [x] Generate doxygen docs
51 | - [x] Provide examples
52 |
53 | # Unit tests
54 | For unit teste Criterion needs to be installed in your system. It can be done by:
55 |
56 | ```bash
57 | wget -qO- https://github.com/Snaipe/Criterion/releases/download/v2.3.3/criterion-v2.3.3-linux-x86_64.tar.bz2 | tar -xjvf -
58 | sudo cp -a criterion-v2.3.3/lib/. /usr/lib
59 | sudo cp -a criterion-v2.3.3/include/. /usr/include
60 | ```
--------------------------------------------------------------------------------
/tests/test.c:
--------------------------------------------------------------------------------
1 | #include
2 | #include
3 | #include
4 | #include
5 | #include
6 |
7 | Test(ring_tests, dummy){
8 | cr_assert(1, "Hello");
9 | }
10 |
11 | Test(ring_tests, init){
12 | RingBuffer_t myRing;
13 | uint8_t buffer [256];
14 | RingInit(&myRing, &buffer[0], 256, sizeof(uint8_t));
15 | cr_assert(256 == myRing.size, "Excepted 'size' to be 256");
16 | cr_assert(buffer == myRing.buffer, "Excepted pointer to be equal");
17 | }
18 |
19 | Test(ring_tests, init_with_null){
20 | RingStatus_t ret;
21 | RingBuffer_t myRing;
22 | uint8_t buf[256];
23 | ret = RingInit(&myRing, NULL, 256, sizeof(uint8_t));
24 | cr_assert(ret == NO_PTR, "Excepted %d, got %d",
25 | NO_PTR, ret);
26 | ret = RingInit(NULL, &buf[0], 256, sizeof(uint8_t));
27 | cr_assert(ret == NO_PTR, "Excepted %d, got %d",
28 | NO_PTR, ret);
29 | }
30 |
31 | Test(ring_tests, init_with_no_size){
32 | RingStatus_t ret;
33 | RingBuffer_t myRing;
34 | uint8_t arr[10];
35 | ret = RingInit(&myRing, &arr[0], 0, sizeof(uint8_t));
36 | cr_assert(NO_DATA == ret, "Excepted %d, got %d",
37 | NO_DATA, ret);
38 | }
39 |
40 | Test(ring_tests, write_byte){
41 | RingBuffer_t myRing;
42 | uint8_t arr[10];
43 | uint8_t testValue = 10;
44 | RingInit(&myRing, &arr[0], 10, sizeof(uint8_t));
45 |
46 | cr_assert(OK == RingWriteElement(&myRing, &testValue));
47 | cr_assert(testValue == arr[0]);
48 | }
49 |
50 | Test(ring_tests, write_to_null_buf){
51 | uint8_t testValue = 10;
52 | cr_assert(NO_PTR == RingWriteElement(NULL, &testValue));
53 | }
54 |
55 | Test(ring_tests, write_multiple_bytes){
56 | RingBuffer_t myRing;
57 | uint8_t arr[10];
58 | uint8_t sizeNum = 5;
59 | uint8_t testValues[5] = {1,2,3,4,5};
60 | RingInit(&myRing, &arr[0], 10, sizeof(uint8_t));
61 |
62 | cr_assert(OK == RingWriteElements(&myRing, &testValues[0], sizeNum));
63 | cr_assert_arr_eq(testValues, arr, sizeNum);
64 | }
65 |
66 | Test(ring_tests, write_multiple_bytes_from_null){
67 | RingBuffer_t myRing;
68 | uint8_t arr[10];
69 | uint8_t sizeNum = 5;
70 | RingInit(&myRing, &arr[0], 10, sizeof(uint8_t));
71 |
72 | cr_assert(NO_PTR == RingWriteElements(&myRing, NULL, sizeNum));
73 | }
74 |
75 | Test(ring_tests, write_multiple_bytes_to_null){
76 | uint8_t sizeNum = 5;
77 | uint8_t testValues[5] = {1,2,3,4,5};
78 |
79 | cr_assert(NO_PTR == RingWriteElements(NULL, &testValues[0], sizeNum));
80 | }
81 |
82 | Test(ring_tests, write_multiple_bytes_no_data){
83 | RingBuffer_t myRing;
84 | uint8_t arr[10];
85 | uint8_t sizeNum = 0;
86 | uint8_t testValues[5] = {1,2,3,4,5};
87 | RingInit(&myRing, &arr[0], 10, sizeof(uint8_t));
88 |
89 | cr_assert(NO_DATA == RingWriteElements(&myRing, &testValues[0], sizeNum));
90 | }
91 |
92 | Test(ring_tests, write_multiple_bytes_overlap)
93 | {
94 | RingBuffer_t myRing;
95 | uint8_t arr[10];
96 | uint8_t sizeNum = 5;
97 | uint8_t testValues[5] = {1,2,3,4,5};
98 | uint8_t arrRef[10] = {3,4,5,0,0,0,0,0,1,2};
99 | RingInit(&myRing, &arr[0], 10, sizeof(uint8_t));
100 | // Sztuczne przesunięcie wskaźnika
101 | myRing.writePtr = 8;
102 | myRing.readPtr = 8;
103 | cr_assert(OK == RingWriteElements(&myRing, &testValues[0], sizeNum));
104 | cr_assert_arr_eq(&arrRef[0], &arr[0], 10);
105 | }
106 |
107 | Test(ring_tests, write_multiple_bytes_no_place)
108 | {
109 | RingBuffer_t myRing;
110 | uint8_t arr[10];
111 | uint8_t sizeNum = 6;
112 | uint8_t testValues[6] = {1,2,3,4,5,6};
113 | uint8_t arrRef[10] = {1,2,3,4,5,6,1,2,3,0};
114 | RingInit(&myRing, &arr[0], 10, sizeof(uint8_t));
115 | cr_assert(OK == RingWriteElements(&myRing, &testValues[0], sizeNum));
116 | cr_assert(NO_PLACE == RingWriteElements(&myRing, &testValues[0], sizeNum));
117 | cr_assert(NO_PLACE == RingWriteElements(&myRing, &testValues[0], sizeNum - 1));
118 | cr_assert(NO_PLACE == RingWriteElements(&myRing, &testValues[0], sizeNum - 2));
119 | cr_assert(OK == RingWriteElements(&myRing, &testValues[0], sizeNum - 3));
120 | cr_assert(NO_PLACE == RingWriteElements(&myRing, &testValues[0], 1));
121 | cr_assert_arr_eq(&arrRef[0], &arr[0], 10);
122 | }
123 |
124 | Test(ring_tests, read_byte_after_init)
125 | {
126 | RingBuffer_t myRing;
127 | uint8_t arr[10];
128 | uint8_t data;
129 |
130 | RingInit(&myRing, &arr[0], 10, sizeof(uint8_t));
131 | cr_assert(NO_DATA == RingReadElement(&myRing, &data));
132 | }
133 |
134 | Test(ring_tests, read_bytes_to_empty)
135 | {
136 | RingBuffer_t myRing;
137 | uint8_t arr[10];
138 | uint8_t sizeNum = 6;
139 | uint8_t testValues[6] = {1,2,3,4,5,6};
140 | uint8_t data;
141 | RingInit(&myRing, &arr[0], 10, sizeof(uint8_t));
142 | cr_assert(NO_DATA == RingReadElement(&myRing, &data));
143 |
144 | cr_assert(OK == RingWriteElements(&myRing, &testValues[0], sizeNum));
145 | for(uint8_t i = 0; i < sizeNum; i++){
146 | cr_assert(OK == RingReadElement(&myRing, &data));
147 | cr_assert(testValues[i] == data);
148 | }
149 | cr_assert(NO_DATA == RingReadElement(&myRing, &data));
150 | //TEST_FAIL_MESSAGE("initial test setup");
151 | }
152 |
153 | Test(ring_tests, get_size)
154 | {
155 | RingBuffer_t myRing;
156 | uint8_t arr[10];
157 |
158 | RingInit(&myRing, &arr[0], 10, sizeof(uint8_t));
159 | cr_assert(10 == RingGetElementsCapacity(&myRing));
160 | }
161 |
162 | Test(ring_tests, get_space)
163 | {
164 | RingBuffer_t myRing;
165 | uint8_t arr[10];
166 | uint8_t data[5] = {1, 1, 1, 1, 1};
167 |
168 | RingInit(&myRing, &arr[0], 10, sizeof(uint8_t));
169 | RingWriteElements(&myRing, &data[0], 5);
170 | cr_assert(4 == RingGetSpace(&myRing));
171 | }
--------------------------------------------------------------------------------
/lib/ring.h:
--------------------------------------------------------------------------------
1 | /**
2 | * @file ring.h
3 | * @author Kacper Brzostowski (kapibrv97@gmail.com)
4 | * @link https://github.com/magiczny-kacper
5 | * @brief FIFO ring buffer driver library header.
6 | * @version 2.0.0
7 | * @date 2021-02-12
8 | *
9 | * @copyright GNU General Public License v3.0
10 | *
11 | */
12 |
13 | /*! \mainpage My Ring Buffer implementation
14 | *
15 | * \section intro_sec Introduction
16 | *
17 | * This is my implementation of ring buffer. It was primary created as a part of bigger project, but I decided to share it with everyone.
18 | * It was created for use with STM32L151 peripherals (UART, SPI). Then I used it on STM32F4, STM32F3, and PIC18F platforms without problems.
19 | * It implements two types of work.
20 | * One is opration on an array pointer, which gives an ability to create multiple buffers with different size,
21 | * but the user must provide an array for buffer.
22 | * Second is with fixed size array, where user only has to create buffer structure, bute every
23 | * buffer have the same size.
24 | *
25 | */
26 |
27 | #ifndef RING_H_
28 | #define RING_H_
29 |
30 | #include
31 |
32 | /**
33 | * @defgroup Ring_Buffer
34 | * @brief FIFO ring buffer library.
35 | * @{
36 | */
37 |
38 | /**
39 | * @brief Ring buffer status enumerator.
40 | *
41 | */
42 | typedef enum{
43 | NO_PTR = -3, /**< Returned if null pointer was given as parameter. */
44 | NO_DATA = -2, /**< Returned if there was no data to read in buffer. */
45 | NO_PLACE = -1, /**< Returned if there was no place to write data in buffer. */
46 | OK = 1 /**< Returned when write/read was succesfull/ */
47 | } RingStatus_t;
48 |
49 | /**
50 | * @brief Buffer handler structure.
51 | *
52 | */
53 | typedef struct{
54 | size_t size; /**< Size of buffer given in elements. */
55 | size_t elementSize; /**< Size of one buffer element. */
56 | size_t sizeB; /**< Size of buffer given in bytes. */
57 | size_t elementsInBuffer; /**< Current count of elements in buffer. */
58 | uint32_t writePtr; /**< Buffer next write pointer. */
59 | uint32_t readPtr; /**< Buffer next read pointer. */
60 | uint32_t place; /**< Place available in buffer. */
61 | void* buffer; /**< Pointer to array holding ring buffer. */
62 | } RingBuffer_t;
63 |
64 | /**
65 | * Function that returns size of whole ring buffer.
66 | *
67 | * @param buffer Pointer to buffer structure, which size has to be returned.
68 | * @retval Size of pointed ring buffer.
69 | */
70 | uint32_t RingGetElementsCapacity (RingBuffer_t* buffer);
71 |
72 | /**
73 | * @brief Function that returns available space in selected buffer.
74 | *
75 | * @param buffer Pointer to buffer structure, which size has to be returned.
76 | * @return uint32_t Available size in provided buffer.
77 | */
78 | uint32_t RingGetSpace (RingBuffer_t* buffer);
79 |
80 | /**
81 | * @brief Function that returns count of data available in buffer.
82 | *
83 | * @param buffer Pointer to buffer structure
84 | * @return uint32_t Data count in buffer.
85 | */
86 | uint32_t RingGetDataCnt (RingBuffer_t* buffer);
87 |
88 | /**
89 | * @brief Function to initialize selected ring buffer.
90 | *
91 | * @param buffer Pointer to buffer structure that has to be initialized.
92 | * @param arrayBuffer Pointer to array used by buffer
93 | * @param bufferSize Size of buffer given in elements
94 | * @param elementSize Size of one element
95 | * @return RingStatus_t
96 | */
97 | RingStatus_t RingInit (RingBuffer_t* buffer, void* arrayBuffer, size_t bufferSize, size_t elementSize);
98 |
99 | /**
100 | * @brief Function to initialize ring buffer with memory allocation
101 | *
102 | * @param buffer Pointer to buffer structure that has to be initialized.
103 | * @param bufferSize Size of buffer given in elements
104 | * @param elementSize Size of one element
105 | * @return RingStatus_t
106 | */
107 | RingStatus_t RingInitAlloc (RingBuffer_t* buffer, size_t bufferSize, size_t elementSize);
108 |
109 | /**
110 | * @brief Addes one byte to the end of buffer.
111 | *
112 | * @param buffer Pointer to buffer to write.
113 | * @param data Data to write.
114 | * @return RingStatus_t Status of write process.
115 | */
116 | RingStatus_t RingWriteElement (RingBuffer_t* buffer, void* data);
117 |
118 | /**
119 | * @brief Writes multiple bytes to buffer.
120 | *
121 | * @param buffer Buffer to write data.
122 | * @param data Data pointer to write.
123 | * @param len Length of data.
124 | * @return RingStatus_t Write status.
125 | */
126 | RingStatus_t RingWriteElements (RingBuffer_t* buffer, void* data, size_t len);
127 |
128 | /**
129 | * @brief Reads one byte from buffer.
130 | *
131 | * @param buffer Buffer to read.
132 | * @param data Pointer to save data.
133 | * @return RingStatus_t Read status.
134 | */
135 | RingStatus_t RingReadElement (RingBuffer_t* buffer, void* data);
136 |
137 | /**
138 | * @brief Reads multiple bytes from buffer.
139 | *
140 | * @param buffer Buffer to read data.
141 | * @param data Pointer to write data.
142 | * @param len Length of data to read.
143 | * @return RingStatus_t Read status.
144 | */
145 | RingStatus_t RingReadElements (RingBuffer_t* buffer, void* data, size_t len);
146 |
147 | /**
148 | * @brief Returns write pointer of buffer.
149 | *
150 | * @param buffer Buffer to get pointer.
151 | * @return uint32_t Write pointer.
152 | */
153 | uint32_t RingGetHead (RingBuffer_t* buffer);
154 |
155 | /**
156 | * @brief Returns read pointer of buffer.
157 | *
158 | * @param buffer Buffer to get pointer.
159 | * @return uint32_t Read pointer.
160 | */
161 | uint32_t RingGetTail (RingBuffer_t* buffer);
162 |
163 | /**
164 | * @brief Gets last element from buffer without taking it from buffer.
165 | *
166 | * @param buffer Buffer to read.
167 | * @return uint32_t Last byte in buffer.
168 | */
169 | RingStatus_t RingGetLastElement(RingBuffer_t* buffer, void* element);
170 |
171 | /**
172 | * @}
173 | *
174 | */
175 | #endif /* RING_H_ */
--------------------------------------------------------------------------------
/Src/ring.h:
--------------------------------------------------------------------------------
1 | /**
2 | * @file ring.h
3 | * @author Kacper Brzostowski (kapibrv97@gmail.com)
4 | * @link https://github.com/magiczny-kacper
5 | * @brief FIFO ring buffer driver library header.
6 | * @version 2.0.0
7 | * @date 2021-02-12
8 | *
9 | * @copyright GNU General Public License v3.0
10 | *
11 | */
12 |
13 | /*! \mainpage My Ring Buffer implementation
14 | *
15 | * \section intro_sec Introduction
16 | *
17 | * This is my implementation of ring buffer. It was primary created as a part of bigger project, but I decided to share it with everyone.
18 | * It was created for use with STM32L151 peripherals (UART, SPI). Then I used it on STM32F4, STM32F3, and PIC18F platforms without problems.
19 | * It implements two types of work.
20 | * One is opration on an array pointer, which gives an ability to create multiple buffers with different size,
21 | * but the user must provide an array for buffer.
22 | * Second is with fixed size array, where user only has to create buffer structure, bute every
23 | * buffer have the same size.
24 | *
25 | */
26 |
27 | #ifndef RING_H_
28 | #define RING_H_
29 |
30 | #include
31 | #include
32 |
33 | /**
34 | * @defgroup Ring_Buffer
35 | * @brief FIFO ring buffer library.
36 | * @{
37 | */
38 |
39 | /**
40 | * @brief Ring buffer status enumerator.
41 | *
42 | */
43 | typedef enum{
44 | NO_PTR = -3, /**< Returned if null pointer was given as parameter. */
45 | NO_DATA = -2, /**< Returned if there was no data to read in buffer. */
46 | NO_PLACE = -1, /**< Returned if there was no place to write data in buffer. */
47 | OK = 1 /**< Returned when write/read was succesfull/ */
48 | } RingStatus_t;
49 |
50 | /**
51 | * @brief Buffer handler structure.
52 | *
53 | */
54 | typedef struct{
55 | size_t size; /**< Size of buffer given in elements. */
56 | size_t elementSize; /**< Size of one buffer element. */
57 | size_t sizeB; /**< Size of buffer given in bytes. */
58 | size_t elementsInBuffer; /**< Current count of elements in buffer. */
59 | uint32_t writePtr; /**< Buffer next write pointer. */
60 | uint32_t readPtr; /**< Buffer next read pointer. */
61 | uint32_t place; /**< Place available in buffer. */
62 | void* buffer; /**< Pointer to array holding ring buffer. */
63 | } RingBuffer_t;
64 |
65 | /**
66 | * Function that returns size of whole ring buffer.
67 | *
68 | * @param buffer Pointer to buffer structure, which size has to be returned.
69 | * @retval Size of pointed ring buffer.
70 | */
71 | uint32_t RingGetElementsCapacity (RingBuffer_t* buffer);
72 |
73 | /**
74 | * @brief Function that returns available space in selected buffer.
75 | *
76 | * @param buffer Pointer to buffer structure, which size has to be returned.
77 | * @return uint32_t Available size in provided buffer.
78 | */
79 | uint32_t RingGetSpace (RingBuffer_t* buffer);
80 |
81 | /**
82 | * @brief Function that returns count of data available in buffer.
83 | *
84 | * @param buffer Pointer to buffer structure
85 | * @return uint32_t Data count in buffer.
86 | */
87 | uint32_t RingGetDataCnt (RingBuffer_t* buffer);
88 |
89 | /**
90 | * @brief Function to initialize selected ring buffer.
91 | *
92 | * @param buffer Pointer to buffer structure that has to be initialized.
93 | * @param arrayBuffer Pointer to array used by buffer
94 | * @param bufferSize Size of buffer given in elements
95 | * @param elementSize Size of one element
96 | * @return RingStatus_t
97 | */
98 | RingStatus_t RingInit (RingBuffer_t* buffer, void* arrayBuffer, size_t bufferSize, size_t elementSize);
99 |
100 | /**
101 | * @brief Function to initialize ring buffer with memory allocation
102 | *
103 | * @param buffer Pointer to buffer structure that has to be initialized.
104 | * @param bufferSize Size of buffer given in elements
105 | * @param elementSize Size of one element
106 | * @return RingStatus_t
107 | */
108 | RingStatus_t RingInitAlloc (RingBuffer_t* buffer, size_t bufferSize, size_t elementSize);
109 |
110 | /**
111 | * @brief Addes one byte to the end of buffer.
112 | *
113 | * @param buffer Pointer to buffer to write.
114 | * @param data Data to write.
115 | * @return RingStatus_t Status of write process.
116 | */
117 | RingStatus_t RingWriteElement (RingBuffer_t* buffer, void* data);
118 |
119 | /**
120 | * @brief Writes multiple bytes to buffer.
121 | *
122 | * @param buffer Buffer to write data.
123 | * @param data Data pointer to write.
124 | * @param len Length of data.
125 | * @return RingStatus_t Write status.
126 | */
127 | RingStatus_t RingWriteElements (RingBuffer_t* buffer, void* data, size_t len);
128 |
129 | /**
130 | * @brief Reads one byte from buffer.
131 | *
132 | * @param buffer Buffer to read.
133 | * @param data Pointer to save data.
134 | * @return RingStatus_t Read status.
135 | */
136 | RingStatus_t RingReadElement (RingBuffer_t* buffer, void* data);
137 |
138 | /**
139 | * @brief Reads multiple bytes from buffer.
140 | *
141 | * @param buffer Buffer to read data.
142 | * @param data Pointer to write data.
143 | * @param len Length of data to read.
144 | * @return RingStatus_t Read status.
145 | */
146 | RingStatus_t RingReadElements (RingBuffer_t* buffer, void* data, size_t len);
147 |
148 | /**
149 | * @brief Returns write pointer of buffer.
150 | *
151 | * @param buffer Buffer to get pointer.
152 | * @return uint32_t Write pointer.
153 | */
154 | uint32_t RingGetHead (RingBuffer_t* buffer);
155 |
156 | /**
157 | * @brief Returns read pointer of buffer.
158 | *
159 | * @param buffer Buffer to get pointer.
160 | * @return uint32_t Read pointer.
161 | */
162 | uint32_t RingGetTail (RingBuffer_t* buffer);
163 |
164 | /**
165 | * @brief Gets last element from buffer without taking it from buffer.
166 | *
167 | * @param buffer Buffer to read.
168 | * @return uint32_t Last byte in buffer.
169 | */
170 | RingStatus_t RingGetLastElement(RingBuffer_t* buffer, void* element);
171 |
172 | /**
173 | * @}
174 | *
175 | */
176 | #endif /* RING_H_ */
177 |
--------------------------------------------------------------------------------
/Src/ring.c:
--------------------------------------------------------------------------------
1 | /**
2 | * @file ring.c
3 | * @author Kacper Brzostowski (kapibrv97@gmail.com)
4 | * @link https://github.com/magiczny-kacper
5 | * @brief Ring buffer library source file.
6 | * @version 2.0.0
7 | * @date 2021-02-12
8 | *
9 | * @copyright Copyright (c) 2020
10 | *
11 | */
12 |
13 | /**
14 | * @copyright GNU General Public License v3.0
15 | * @{
16 | */
17 | #include
18 | #include
19 | #include
20 | #include "ring.h"
21 |
22 | /**< Modulo for operations on array indexes. */
23 | #define MODULO_BUF(value, max) ((value) % (max))
24 |
25 | uint32_t RingGetElementsCapacity (RingBuffer_t* buffer){
26 | return buffer -> size;
27 | }
28 |
29 | uint32_t RingGetSpace (RingBuffer_t* buffer){
30 | return buffer -> place;
31 | }
32 |
33 | uint32_t RingGetDataCnt (RingBuffer_t* buffer){
34 | return buffer -> size - RingGetSpace(buffer);
35 | }
36 |
37 | /* DONE: Add null pointer exceptions. */
38 | RingStatus_t RingInit (RingBuffer_t* buffer, void* arrayBuffer, size_t bufferSize, size_t elementSize){
39 | if(NULL == buffer) return NO_PTR;
40 | if(NULL == arrayBuffer) return NO_PTR;
41 |
42 | memset(buffer, 0, sizeof(RingBuffer_t));
43 |
44 | if(arrayBuffer == NULL) return NO_PTR;
45 | if(bufferSize <= 0) return NO_DATA;
46 |
47 | buffer -> buffer = arrayBuffer;
48 | buffer -> size = bufferSize;
49 | buffer -> place = buffer -> size - 1;
50 | buffer -> writePtr = 0;
51 | buffer -> readPtr = 0;
52 | buffer -> elementSize = elementSize;
53 | buffer -> sizeB = buffer -> elementSize * buffer -> size;
54 |
55 | memset(buffer -> buffer, 0, buffer -> sizeB);
56 | return OK;
57 | }
58 |
59 | RingStatus_t RingInitAlloc (RingBuffer_t* buffer, size_t bufferSize, size_t elementSize){
60 | void* ptr;
61 | size_t reqSize = elementSize * bufferSize;
62 | if(NULL == buffer){
63 | return NO_PTR;
64 | }
65 | ptr = malloc(reqSize);
66 | if(NULL == ptr){
67 | return NO_PTR;
68 | }
69 | return RingInit(buffer, ptr, bufferSize, elementSize);
70 | }
71 |
72 | RingStatus_t RingWriteElement (RingBuffer_t* buffer, void* data){
73 | RingStatus_t retval = OK;
74 |
75 | if(buffer == NULL) return NO_PTR;
76 | if(data == NULL) return NO_PTR;
77 | if(buffer -> buffer == NULL) return NO_PTR;
78 |
79 | uint32_t tempHead = buffer -> writePtr;
80 | uint32_t tempTail = buffer -> readPtr;
81 | size_t elSize = buffer -> elementSize;
82 | size_t bufferSize = buffer -> sizeB;
83 |
84 | void* wrPtr;
85 | wrPtr = buffer -> buffer + tempHead;
86 |
87 | tempHead = MODULO_BUF(tempHead + elSize, bufferSize);
88 | if(tempHead != tempTail){
89 | memcpy(wrPtr, data, elSize);
90 | buffer -> writePtr = tempHead;
91 | buffer -> place --;
92 | }else{
93 | retval = NO_PLACE;
94 | }
95 | return retval;
96 | }
97 |
98 | RingStatus_t RingWriteElements (RingBuffer_t* buffer, void* data, size_t len){
99 | RingStatus_t retval = OK;
100 |
101 | if(buffer == NULL) return NO_PTR;
102 | if(data == NULL) return NO_PTR;
103 | if(buffer -> buffer == NULL) return NO_PTR;
104 | if(len <= 0) return NO_DATA;
105 |
106 | uint32_t tempHead = buffer -> writePtr;
107 | uint32_t tempPlace = buffer -> place;
108 |
109 | size_t elSize = buffer -> elementSize;
110 | size_t bytesToWrite = elSize * len;
111 | size_t bufferSize = buffer -> size;
112 | size_t bufferSizeB = buffer -> sizeB;
113 | uint8_t* wrPtr;
114 |
115 | wrPtr = buffer -> buffer + tempHead;
116 |
117 | if(tempPlace >= len){
118 | if(tempHead + bytesToWrite >= bufferSizeB){
119 | uint32_t temp1, temp2;
120 | temp1 = bufferSizeB - tempHead;
121 | memcpy(wrPtr, data, temp1);
122 | data += temp1;
123 | temp2 = len - temp1;
124 | wrPtr = buffer -> buffer;
125 | memcpy(wrPtr, data, temp2);
126 | }else{
127 | memcpy(wrPtr, data, len);
128 | tempHead = MODULO_BUF(tempHead + len, bufferSize);
129 | }
130 | tempPlace -= len;
131 | buffer -> writePtr = tempHead;
132 | buffer -> place = tempPlace;
133 | }else{
134 | retval = NO_PLACE;
135 | }
136 |
137 | return retval;
138 | }
139 |
140 | RingStatus_t RingReadElement (RingBuffer_t* buffer, void* data){
141 | RingStatus_t retval = OK;
142 | uint32_t tempHead = buffer -> writePtr;
143 | uint32_t tempTail = buffer -> readPtr;
144 | uint32_t tempPlace = buffer -> place;
145 | size_t bufferSize = buffer -> size;
146 | size_t elSize = buffer -> elementSize;
147 | void* wrPtr;
148 | wrPtr = buffer -> buffer + tempTail;
149 |
150 | if(tempHead != tempTail){
151 | memcpy(data, wrPtr, elSize);
152 | tempTail = MODULO_BUF(tempTail + 1, bufferSize);
153 | tempPlace++;
154 | buffer -> readPtr = tempTail;
155 | buffer -> place = tempPlace;
156 | }else{
157 | retval = NO_DATA;
158 | }
159 | return retval;
160 | }
161 |
162 | RingStatus_t RingReadElements (RingBuffer_t* buffer, void* data, size_t len){
163 | RingStatus_t retval = OK;
164 | uint32_t tempHead = buffer -> writePtr;
165 | uint32_t tempTail = buffer -> readPtr;
166 | uint32_t tempPlace = buffer -> place;
167 | uint8_t* wrPtr;
168 | wrPtr = buffer -> buffer + tempHead;
169 | if(tempHead != tempTail){
170 | if(tempTail + len > buffer -> size - 1){
171 | uint32_t temp1, temp2;
172 | temp1 = buffer -> size - tempTail;
173 | memcpy(data, wrPtr, temp1);
174 | data += temp1;
175 | temp2 = len - temp1;
176 | wrPtr = buffer -> buffer;
177 | memcpy(data, wrPtr, temp2);
178 | tempTail = temp2;
179 | }else{
180 | memcpy(data, wrPtr, len);
181 | tempTail += len;
182 | }
183 | tempPlace += len;
184 | buffer -> readPtr = tempTail;
185 | buffer -> place = tempPlace;
186 | }else{
187 | retval = NO_DATA;
188 | }
189 | return retval;
190 | }
191 |
192 | uint32_t RingGetHead (RingBuffer_t* buffer){
193 | return buffer -> writePtr;
194 | }
195 |
196 | uint32_t RingGetTail (RingBuffer_t* buffer){
197 | return buffer -> readPtr;
198 | }
199 |
200 | RingStatus_t RingGetLastElement(RingBuffer_t* buffer, void* element){
201 | RingStatus_t ret = OK;
202 | if(buffer && element){
203 | memcpy(element, buffer -> buffer + buffer -> writePtr, buffer -> elementSize);
204 | }else{
205 | ret = NO_PTR;
206 | }
207 | return ret;
208 | }
209 |
210 | /**
211 | * @}
212 | *
213 | */
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/doxyConfig:
--------------------------------------------------------------------------------
1 | # Doxyfile 1.8.18
2 |
3 | # This file describes the settings to be used by the documentation system
4 | # doxygen (www.doxygen.org) for a project.
5 | #
6 | # All text after a double hash (##) is considered a comment and is placed in
7 | # front of the TAG it is preceding.
8 | #
9 | # All text after a single hash (#) is considered a comment and will be ignored.
10 | # The format is:
11 | # TAG = value [value, ...]
12 | # For lists, items can also be appended using:
13 | # TAG += value [value, ...]
14 | # Values that contain spaces should be placed between quotes (\" \").
15 |
16 | #---------------------------------------------------------------------------
17 | # Project related configuration options
18 | #---------------------------------------------------------------------------
19 |
20 | # This tag specifies the encoding used for all characters in the configuration
21 | # file that follow. The default is UTF-8 which is also the encoding used for all
22 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the
23 | # iconv built into libc) for the transcoding. See
24 | # https://www.gnu.org/software/libiconv/ for the list of possible encodings.
25 | # The default value is: UTF-8.
26 |
27 | DOXYFILE_ENCODING = UTF-8
28 |
29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30 | # double-quotes, unless you are using Doxywizard) that should identify the
31 | # project for which the documentation is generated. This name is used in the
32 | # title of most generated pages and in a few other places.
33 | # The default value is: My Project.
34 |
35 | PROJECT_NAME = "Ring Buffer"
36 |
37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38 | # could be handy for archiving the generated documentation or if some version
39 | # control system is used.
40 |
41 | PROJECT_NUMBER =
42 |
43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description
44 | # for a project that appears at the top of each page and should give viewer a
45 | # quick idea about the purpose of the project. Keep the description short.
46 |
47 | PROJECT_BRIEF =
48 |
49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50 | # in the documentation. The maximum height of the logo should not exceed 55
51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52 | # the logo to the output directory.
53 |
54 | PROJECT_LOGO =
55 |
56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57 | # into which the generated documentation will be written. If a relative path is
58 | # entered, it will be relative to the location where doxygen was started. If
59 | # left blank the current directory will be used.
60 |
61 | OUTPUT_DIRECTORY =
62 |
63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64 | # directories (in 2 levels) under the output directory of each output format and
65 | # will distribute the generated files over these directories. Enabling this
66 | # option can be useful when feeding doxygen a huge amount of source files, where
67 | # putting all generated files in the same directory would otherwise causes
68 | # performance problems for the file system.
69 | # The default value is: NO.
70 |
71 | CREATE_SUBDIRS = YES
72 |
73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74 | # characters to appear in the names of generated files. If set to NO, non-ASCII
75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76 | # U+3044.
77 | # The default value is: NO.
78 |
79 | ALLOW_UNICODE_NAMES = NO
80 |
81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all
82 | # documentation generated by doxygen is written. Doxygen will use this
83 | # information to generate all constant output in the proper language.
84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91 | # Ukrainian and Vietnamese.
92 | # The default value is: English.
93 |
94 | OUTPUT_LANGUAGE = English
95 |
96 | # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
97 | # documentation generated by doxygen is written. Doxygen will use this
98 | # information to generate all generated output in the proper direction.
99 | # Possible values are: None, LTR, RTL and Context.
100 | # The default value is: None.
101 |
102 | OUTPUT_TEXT_DIRECTION = None
103 |
104 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
105 | # descriptions after the members that are listed in the file and class
106 | # documentation (similar to Javadoc). Set to NO to disable this.
107 | # The default value is: YES.
108 |
109 | BRIEF_MEMBER_DESC = YES
110 |
111 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
112 | # description of a member or function before the detailed description
113 | #
114 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
115 | # brief descriptions will be completely suppressed.
116 | # The default value is: YES.
117 |
118 | REPEAT_BRIEF = YES
119 |
120 | # This tag implements a quasi-intelligent brief description abbreviator that is
121 | # used to form the text in various listings. Each string in this list, if found
122 | # as the leading text of the brief description, will be stripped from the text
123 | # and the result, after processing the whole list, is used as the annotated
124 | # text. Otherwise, the brief description is used as-is. If left blank, the
125 | # following values are used ($name is automatically replaced with the name of
126 | # the entity):The $name class, The $name widget, The $name file, is, provides,
127 | # specifies, contains, represents, a, an and the.
128 |
129 | ABBREVIATE_BRIEF = "The $name class" \
130 | "The $name widget" \
131 | "The $name file" \
132 | is \
133 | provides \
134 | specifies \
135 | contains \
136 | represents \
137 | a \
138 | an \
139 | the
140 |
141 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
142 | # doxygen will generate a detailed section even if there is only a brief
143 | # description.
144 | # The default value is: NO.
145 |
146 | ALWAYS_DETAILED_SEC = NO
147 |
148 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
149 | # inherited members of a class in the documentation of that class as if those
150 | # members were ordinary class members. Constructors, destructors and assignment
151 | # operators of the base classes will not be shown.
152 | # The default value is: NO.
153 |
154 | INLINE_INHERITED_MEMB = NO
155 |
156 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
157 | # before files name in the file list and in the header files. If set to NO the
158 | # shortest path that makes the file name unique will be used
159 | # The default value is: YES.
160 |
161 | FULL_PATH_NAMES = YES
162 |
163 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
164 | # Stripping is only done if one of the specified strings matches the left-hand
165 | # part of the path. The tag can be used to show relative paths in the file list.
166 | # If left blank the directory from which doxygen is run is used as the path to
167 | # strip.
168 | #
169 | # Note that you can specify absolute paths here, but also relative paths, which
170 | # will be relative from the directory where doxygen is started.
171 | # This tag requires that the tag FULL_PATH_NAMES is set to YES.
172 |
173 | STRIP_FROM_PATH =
174 |
175 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
176 | # path mentioned in the documentation of a class, which tells the reader which
177 | # header file to include in order to use a class. If left blank only the name of
178 | # the header file containing the class definition is used. Otherwise one should
179 | # specify the list of include paths that are normally passed to the compiler
180 | # using the -I flag.
181 |
182 | STRIP_FROM_INC_PATH =
183 |
184 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
185 | # less readable) file names. This can be useful is your file systems doesn't
186 | # support long names like on DOS, Mac, or CD-ROM.
187 | # The default value is: NO.
188 |
189 | SHORT_NAMES = NO
190 |
191 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
192 | # first line (until the first dot) of a Javadoc-style comment as the brief
193 | # description. If set to NO, the Javadoc-style will behave just like regular Qt-
194 | # style comments (thus requiring an explicit @brief command for a brief
195 | # description.)
196 | # The default value is: NO.
197 |
198 | JAVADOC_AUTOBRIEF = NO
199 |
200 | # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
201 | # such as
202 | # /***************
203 | # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
204 | # Javadoc-style will behave just like regular comments and it will not be
205 | # interpreted by doxygen.
206 | # The default value is: NO.
207 |
208 | JAVADOC_BANNER = NO
209 |
210 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
211 | # line (until the first dot) of a Qt-style comment as the brief description. If
212 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
213 | # requiring an explicit \brief command for a brief description.)
214 | # The default value is: NO.
215 |
216 | QT_AUTOBRIEF = NO
217 |
218 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
219 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
220 | # a brief description. This used to be the default behavior. The new default is
221 | # to treat a multi-line C++ comment block as a detailed description. Set this
222 | # tag to YES if you prefer the old behavior instead.
223 | #
224 | # Note that setting this tag to YES also means that rational rose comments are
225 | # not recognized any more.
226 | # The default value is: NO.
227 |
228 | MULTILINE_CPP_IS_BRIEF = NO
229 |
230 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
231 | # documentation from any documented member that it re-implements.
232 | # The default value is: YES.
233 |
234 | INHERIT_DOCS = YES
235 |
236 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
237 | # page for each member. If set to NO, the documentation of a member will be part
238 | # of the file/class/namespace that contains it.
239 | # The default value is: NO.
240 |
241 | SEPARATE_MEMBER_PAGES = NO
242 |
243 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
244 | # uses this value to replace tabs by spaces in code fragments.
245 | # Minimum value: 1, maximum value: 16, default value: 4.
246 |
247 | TAB_SIZE = 4
248 |
249 | # This tag can be used to specify a number of aliases that act as commands in
250 | # the documentation. An alias has the form:
251 | # name=value
252 | # For example adding
253 | # "sideeffect=@par Side Effects:\n"
254 | # will allow you to put the command \sideeffect (or @sideeffect) in the
255 | # documentation, which will result in a user-defined paragraph with heading
256 | # "Side Effects:". You can put \n's in the value part of an alias to insert
257 | # newlines (in the resulting output). You can put ^^ in the value part of an
258 | # alias to insert a newline as if a physical newline was in the original file.
259 | # When you need a literal { or } or , in the value part of an alias you have to
260 | # escape them by means of a backslash (\), this can lead to conflicts with the
261 | # commands \{ and \} for these it is advised to use the version @{ and @} or use
262 | # a double escape (\\{ and \\})
263 |
264 | ALIASES =
265 |
266 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
267 | # only. Doxygen will then generate output that is more tailored for C. For
268 | # instance, some of the names that are used will be different. The list of all
269 | # members will be omitted, etc.
270 | # The default value is: NO.
271 |
272 | OPTIMIZE_OUTPUT_FOR_C = YES
273 |
274 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
275 | # Python sources only. Doxygen will then generate output that is more tailored
276 | # for that language. For instance, namespaces will be presented as packages,
277 | # qualified scopes will look different, etc.
278 | # The default value is: NO.
279 |
280 | OPTIMIZE_OUTPUT_JAVA = NO
281 |
282 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
283 | # sources. Doxygen will then generate output that is tailored for Fortran.
284 | # The default value is: NO.
285 |
286 | OPTIMIZE_FOR_FORTRAN = NO
287 |
288 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
289 | # sources. Doxygen will then generate output that is tailored for VHDL.
290 | # The default value is: NO.
291 |
292 | OPTIMIZE_OUTPUT_VHDL = NO
293 |
294 | # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
295 | # sources only. Doxygen will then generate output that is more tailored for that
296 | # language. For instance, namespaces will be presented as modules, types will be
297 | # separated into more groups, etc.
298 | # The default value is: NO.
299 |
300 | OPTIMIZE_OUTPUT_SLICE = NO
301 |
302 | # Doxygen selects the parser to use depending on the extension of the files it
303 | # parses. With this tag you can assign which parser to use for a given
304 | # extension. Doxygen has a built-in mapping, but you can override or extend it
305 | # using this tag. The format is ext=language, where ext is a file extension, and
306 | # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
307 | # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
308 | # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
309 | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
310 | # tries to guess whether the code is fixed or free formatted code, this is the
311 | # default for Fortran type files). For instance to make doxygen treat .inc files
312 | # as Fortran files (default is PHP), and .f files as C (default is Fortran),
313 | # use: inc=Fortran f=C.
314 | #
315 | # Note: For files without extension you can use no_extension as a placeholder.
316 | #
317 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
318 | # the files are not read by doxygen.
319 |
320 | EXTENSION_MAPPING =
321 |
322 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
323 | # according to the Markdown format, which allows for more readable
324 | # documentation. See https://daringfireball.net/projects/markdown/ for details.
325 | # The output of markdown processing is further processed by doxygen, so you can
326 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
327 | # case of backward compatibilities issues.
328 | # The default value is: YES.
329 |
330 | MARKDOWN_SUPPORT = YES
331 |
332 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
333 | # to that level are automatically included in the table of contents, even if
334 | # they do not have an id attribute.
335 | # Note: This feature currently applies only to Markdown headings.
336 | # Minimum value: 0, maximum value: 99, default value: 5.
337 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
338 |
339 | TOC_INCLUDE_HEADINGS = 5
340 |
341 | # When enabled doxygen tries to link words that correspond to documented
342 | # classes, or namespaces to their corresponding documentation. Such a link can
343 | # be prevented in individual cases by putting a % sign in front of the word or
344 | # globally by setting AUTOLINK_SUPPORT to NO.
345 | # The default value is: YES.
346 |
347 | AUTOLINK_SUPPORT = YES
348 |
349 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
350 | # to include (a tag file for) the STL sources as input, then you should set this
351 | # tag to YES in order to let doxygen match functions declarations and
352 | # definitions whose arguments contain STL classes (e.g. func(std::string);
353 | # versus func(std::string) {}). This also make the inheritance and collaboration
354 | # diagrams that involve STL classes more complete and accurate.
355 | # The default value is: NO.
356 |
357 | BUILTIN_STL_SUPPORT = NO
358 |
359 | # If you use Microsoft's C++/CLI language, you should set this option to YES to
360 | # enable parsing support.
361 | # The default value is: NO.
362 |
363 | CPP_CLI_SUPPORT = NO
364 |
365 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
366 | # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
367 | # will parse them like normal C++ but will assume all classes use public instead
368 | # of private inheritance when no explicit protection keyword is present.
369 | # The default value is: NO.
370 |
371 | SIP_SUPPORT = NO
372 |
373 | # For Microsoft's IDL there are propget and propput attributes to indicate
374 | # getter and setter methods for a property. Setting this option to YES will make
375 | # doxygen to replace the get and set methods by a property in the documentation.
376 | # This will only work if the methods are indeed getting or setting a simple
377 | # type. If this is not the case, or you want to show the methods anyway, you
378 | # should set this option to NO.
379 | # The default value is: YES.
380 |
381 | IDL_PROPERTY_SUPPORT = YES
382 |
383 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
384 | # tag is set to YES then doxygen will reuse the documentation of the first
385 | # member in the group (if any) for the other members of the group. By default
386 | # all members of a group must be documented explicitly.
387 | # The default value is: NO.
388 |
389 | DISTRIBUTE_GROUP_DOC = NO
390 |
391 | # If one adds a struct or class to a group and this option is enabled, then also
392 | # any nested class or struct is added to the same group. By default this option
393 | # is disabled and one has to add nested compounds explicitly via \ingroup.
394 | # The default value is: NO.
395 |
396 | GROUP_NESTED_COMPOUNDS = NO
397 |
398 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type
399 | # (for instance a group of public functions) to be put as a subgroup of that
400 | # type (e.g. under the Public Functions section). Set it to NO to prevent
401 | # subgrouping. Alternatively, this can be done per class using the
402 | # \nosubgrouping command.
403 | # The default value is: YES.
404 |
405 | SUBGROUPING = YES
406 |
407 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
408 | # are shown inside the group in which they are included (e.g. using \ingroup)
409 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
410 | # and RTF).
411 | #
412 | # Note that this feature does not work in combination with
413 | # SEPARATE_MEMBER_PAGES.
414 | # The default value is: NO.
415 |
416 | INLINE_GROUPED_CLASSES = NO
417 |
418 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
419 | # with only public data fields or simple typedef fields will be shown inline in
420 | # the documentation of the scope in which they are defined (i.e. file,
421 | # namespace, or group documentation), provided this scope is documented. If set
422 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and
423 | # Man pages) or section (for LaTeX and RTF).
424 | # The default value is: NO.
425 |
426 | INLINE_SIMPLE_STRUCTS = NO
427 |
428 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
429 | # enum is documented as struct, union, or enum with the name of the typedef. So
430 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
431 | # with name TypeT. When disabled the typedef will appear as a member of a file,
432 | # namespace, or class. And the struct will be named TypeS. This can typically be
433 | # useful for C code in case the coding convention dictates that all compound
434 | # types are typedef'ed and only the typedef is referenced, never the tag name.
435 | # The default value is: NO.
436 |
437 | TYPEDEF_HIDES_STRUCT = NO
438 |
439 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
440 | # cache is used to resolve symbols given their name and scope. Since this can be
441 | # an expensive process and often the same symbol appears multiple times in the
442 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
443 | # doxygen will become slower. If the cache is too large, memory is wasted. The
444 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
445 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
446 | # symbols. At the end of a run doxygen will report the cache usage and suggest
447 | # the optimal cache size from a speed point of view.
448 | # Minimum value: 0, maximum value: 9, default value: 0.
449 |
450 | LOOKUP_CACHE_SIZE = 0
451 |
452 | #---------------------------------------------------------------------------
453 | # Build related configuration options
454 | #---------------------------------------------------------------------------
455 |
456 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
457 | # documentation are documented, even if no documentation was available. Private
458 | # class members and static file members will be hidden unless the
459 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
460 | # Note: This will also disable the warnings about undocumented members that are
461 | # normally produced when WARNINGS is set to YES.
462 | # The default value is: NO.
463 |
464 | EXTRACT_ALL = NO
465 |
466 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
467 | # be included in the documentation.
468 | # The default value is: NO.
469 |
470 | EXTRACT_PRIVATE = NO
471 |
472 | # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
473 | # methods of a class will be included in the documentation.
474 | # The default value is: NO.
475 |
476 | EXTRACT_PRIV_VIRTUAL = NO
477 |
478 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
479 | # scope will be included in the documentation.
480 | # The default value is: NO.
481 |
482 | EXTRACT_PACKAGE = NO
483 |
484 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
485 | # included in the documentation.
486 | # The default value is: NO.
487 |
488 | EXTRACT_STATIC = NO
489 |
490 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
491 | # locally in source files will be included in the documentation. If set to NO,
492 | # only classes defined in header files are included. Does not have any effect
493 | # for Java sources.
494 | # The default value is: YES.
495 |
496 | EXTRACT_LOCAL_CLASSES = YES
497 |
498 | # This flag is only useful for Objective-C code. If set to YES, local methods,
499 | # which are defined in the implementation section but not in the interface are
500 | # included in the documentation. If set to NO, only methods in the interface are
501 | # included.
502 | # The default value is: NO.
503 |
504 | EXTRACT_LOCAL_METHODS = NO
505 |
506 | # If this flag is set to YES, the members of anonymous namespaces will be
507 | # extracted and appear in the documentation as a namespace called
508 | # 'anonymous_namespace{file}', where file will be replaced with the base name of
509 | # the file that contains the anonymous namespace. By default anonymous namespace
510 | # are hidden.
511 | # The default value is: NO.
512 |
513 | EXTRACT_ANON_NSPACES = NO
514 |
515 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
516 | # undocumented members inside documented classes or files. If set to NO these
517 | # members will be included in the various overviews, but no documentation
518 | # section is generated. This option has no effect if EXTRACT_ALL is enabled.
519 | # The default value is: NO.
520 |
521 | HIDE_UNDOC_MEMBERS = NO
522 |
523 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
524 | # undocumented classes that are normally visible in the class hierarchy. If set
525 | # to NO, these classes will be included in the various overviews. This option
526 | # has no effect if EXTRACT_ALL is enabled.
527 | # The default value is: NO.
528 |
529 | HIDE_UNDOC_CLASSES = NO
530 |
531 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
532 | # declarations. If set to NO, these declarations will be included in the
533 | # documentation.
534 | # The default value is: NO.
535 |
536 | HIDE_FRIEND_COMPOUNDS = NO
537 |
538 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
539 | # documentation blocks found inside the body of a function. If set to NO, these
540 | # blocks will be appended to the function's detailed documentation block.
541 | # The default value is: NO.
542 |
543 | HIDE_IN_BODY_DOCS = NO
544 |
545 | # The INTERNAL_DOCS tag determines if documentation that is typed after a
546 | # \internal command is included. If the tag is set to NO then the documentation
547 | # will be excluded. Set it to YES to include the internal documentation.
548 | # The default value is: NO.
549 |
550 | INTERNAL_DOCS = NO
551 |
552 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
553 | # names in lower-case letters. If set to YES, upper-case letters are also
554 | # allowed. This is useful if you have classes or files whose names only differ
555 | # in case and if your file system supports case sensitive file names. Windows
556 | # (including Cygwin) ands Mac users are advised to set this option to NO.
557 | # The default value is: system dependent.
558 |
559 | CASE_SENSE_NAMES = YES
560 |
561 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
562 | # their full class and namespace scopes in the documentation. If set to YES, the
563 | # scope will be hidden.
564 | # The default value is: NO.
565 |
566 | HIDE_SCOPE_NAMES = NO
567 |
568 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
569 | # append additional text to a page's title, such as Class Reference. If set to
570 | # YES the compound reference will be hidden.
571 | # The default value is: NO.
572 |
573 | HIDE_COMPOUND_REFERENCE= NO
574 |
575 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
576 | # the files that are included by a file in the documentation of that file.
577 | # The default value is: YES.
578 |
579 | SHOW_INCLUDE_FILES = YES
580 |
581 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
582 | # grouped member an include statement to the documentation, telling the reader
583 | # which file to include in order to use the member.
584 | # The default value is: NO.
585 |
586 | SHOW_GROUPED_MEMB_INC = NO
587 |
588 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
589 | # files with double quotes in the documentation rather than with sharp brackets.
590 | # The default value is: NO.
591 |
592 | FORCE_LOCAL_INCLUDES = NO
593 |
594 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
595 | # documentation for inline members.
596 | # The default value is: YES.
597 |
598 | INLINE_INFO = YES
599 |
600 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
601 | # (detailed) documentation of file and class members alphabetically by member
602 | # name. If set to NO, the members will appear in declaration order.
603 | # The default value is: YES.
604 |
605 | SORT_MEMBER_DOCS = YES
606 |
607 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
608 | # descriptions of file, namespace and class members alphabetically by member
609 | # name. If set to NO, the members will appear in declaration order. Note that
610 | # this will also influence the order of the classes in the class list.
611 | # The default value is: NO.
612 |
613 | SORT_BRIEF_DOCS = NO
614 |
615 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
616 | # (brief and detailed) documentation of class members so that constructors and
617 | # destructors are listed first. If set to NO the constructors will appear in the
618 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
619 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
620 | # member documentation.
621 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
622 | # detailed member documentation.
623 | # The default value is: NO.
624 |
625 | SORT_MEMBERS_CTORS_1ST = NO
626 |
627 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
628 | # of group names into alphabetical order. If set to NO the group names will
629 | # appear in their defined order.
630 | # The default value is: NO.
631 |
632 | SORT_GROUP_NAMES = NO
633 |
634 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
635 | # fully-qualified names, including namespaces. If set to NO, the class list will
636 | # be sorted only by class name, not including the namespace part.
637 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
638 | # Note: This option applies only to the class list, not to the alphabetical
639 | # list.
640 | # The default value is: NO.
641 |
642 | SORT_BY_SCOPE_NAME = NO
643 |
644 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
645 | # type resolution of all parameters of a function it will reject a match between
646 | # the prototype and the implementation of a member function even if there is
647 | # only one candidate or it is obvious which candidate to choose by doing a
648 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
649 | # accept a match between prototype and implementation in such cases.
650 | # The default value is: NO.
651 |
652 | STRICT_PROTO_MATCHING = NO
653 |
654 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
655 | # list. This list is created by putting \todo commands in the documentation.
656 | # The default value is: YES.
657 |
658 | GENERATE_TODOLIST = YES
659 |
660 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
661 | # list. This list is created by putting \test commands in the documentation.
662 | # The default value is: YES.
663 |
664 | GENERATE_TESTLIST = YES
665 |
666 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
667 | # list. This list is created by putting \bug commands in the documentation.
668 | # The default value is: YES.
669 |
670 | GENERATE_BUGLIST = YES
671 |
672 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
673 | # the deprecated list. This list is created by putting \deprecated commands in
674 | # the documentation.
675 | # The default value is: YES.
676 |
677 | GENERATE_DEPRECATEDLIST= YES
678 |
679 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation
680 | # sections, marked by \if ... \endif and \cond
681 | # ... \endcond blocks.
682 |
683 | ENABLED_SECTIONS =
684 |
685 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
686 | # initial value of a variable or macro / define can have for it to appear in the
687 | # documentation. If the initializer consists of more lines than specified here
688 | # it will be hidden. Use a value of 0 to hide initializers completely. The
689 | # appearance of the value of individual variables and macros / defines can be
690 | # controlled using \showinitializer or \hideinitializer command in the
691 | # documentation regardless of this setting.
692 | # Minimum value: 0, maximum value: 10000, default value: 30.
693 |
694 | MAX_INITIALIZER_LINES = 30
695 |
696 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
697 | # the bottom of the documentation of classes and structs. If set to YES, the
698 | # list will mention the files that were used to generate the documentation.
699 | # The default value is: YES.
700 |
701 | SHOW_USED_FILES = YES
702 |
703 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
704 | # will remove the Files entry from the Quick Index and from the Folder Tree View
705 | # (if specified).
706 | # The default value is: YES.
707 |
708 | SHOW_FILES = YES
709 |
710 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
711 | # page. This will remove the Namespaces entry from the Quick Index and from the
712 | # Folder Tree View (if specified).
713 | # The default value is: YES.
714 |
715 | SHOW_NAMESPACES = YES
716 |
717 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that
718 | # doxygen should invoke to get the current version for each file (typically from
719 | # the version control system). Doxygen will invoke the program by executing (via
720 | # popen()) the command command input-file, where command is the value of the
721 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
722 | # by doxygen. Whatever the program writes to standard output is used as the file
723 | # version. For an example see the documentation.
724 |
725 | FILE_VERSION_FILTER =
726 |
727 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
728 | # by doxygen. The layout file controls the global structure of the generated
729 | # output files in an output format independent way. To create the layout file
730 | # that represents doxygen's defaults, run doxygen with the -l option. You can
731 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml
732 | # will be used as the name of the layout file.
733 | #
734 | # Note that if you run doxygen from a directory containing a file called
735 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
736 | # tag is left empty.
737 |
738 | LAYOUT_FILE =
739 |
740 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
741 | # the reference definitions. This must be a list of .bib files. The .bib
742 | # extension is automatically appended if omitted. This requires the bibtex tool
743 | # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
744 | # For LaTeX the style of the bibliography can be controlled using
745 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
746 | # search path. See also \cite for info how to create references.
747 |
748 | CITE_BIB_FILES =
749 |
750 | #---------------------------------------------------------------------------
751 | # Configuration options related to warning and progress messages
752 | #---------------------------------------------------------------------------
753 |
754 | # The QUIET tag can be used to turn on/off the messages that are generated to
755 | # standard output by doxygen. If QUIET is set to YES this implies that the
756 | # messages are off.
757 | # The default value is: NO.
758 |
759 | QUIET = NO
760 |
761 | # The WARNINGS tag can be used to turn on/off the warning messages that are
762 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
763 | # this implies that the warnings are on.
764 | #
765 | # Tip: Turn warnings on while writing the documentation.
766 | # The default value is: YES.
767 |
768 | WARNINGS = YES
769 |
770 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
771 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
772 | # will automatically be disabled.
773 | # The default value is: YES.
774 |
775 | WARN_IF_UNDOCUMENTED = YES
776 |
777 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
778 | # potential errors in the documentation, such as not documenting some parameters
779 | # in a documented function, or documenting parameters that don't exist or using
780 | # markup commands wrongly.
781 | # The default value is: YES.
782 |
783 | WARN_IF_DOC_ERROR = YES
784 |
785 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
786 | # are documented, but have no documentation for their parameters or return
787 | # value. If set to NO, doxygen will only warn about wrong or incomplete
788 | # parameter documentation, but not about the absence of documentation. If
789 | # EXTRACT_ALL is set to YES then this flag will automatically be disabled.
790 | # The default value is: NO.
791 |
792 | WARN_NO_PARAMDOC = NO
793 |
794 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
795 | # a warning is encountered.
796 | # The default value is: NO.
797 |
798 | WARN_AS_ERROR = NO
799 |
800 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen
801 | # can produce. The string should contain the $file, $line, and $text tags, which
802 | # will be replaced by the file and line number from which the warning originated
803 | # and the warning text. Optionally the format may contain $version, which will
804 | # be replaced by the version of the file (if it could be obtained via
805 | # FILE_VERSION_FILTER)
806 | # The default value is: $file:$line: $text.
807 |
808 | WARN_FORMAT = "$file:$line: $text"
809 |
810 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error
811 | # messages should be written. If left blank the output is written to standard
812 | # error (stderr).
813 |
814 | WARN_LOGFILE =
815 |
816 | #---------------------------------------------------------------------------
817 | # Configuration options related to the input files
818 | #---------------------------------------------------------------------------
819 |
820 | # The INPUT tag is used to specify the files and/or directories that contain
821 | # documented source files. You may enter file names like myfile.cpp or
822 | # directories like /usr/src/myproject. Separate the files or directories with
823 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
824 | # Note: If this tag is empty the current directory is searched.
825 |
826 | INPUT = Src
827 |
828 | # This tag can be used to specify the character encoding of the source files
829 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
830 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
831 | # documentation (see: https://www.gnu.org/software/libiconv/) for the list of
832 | # possible encodings.
833 | # The default value is: UTF-8.
834 |
835 | INPUT_ENCODING = UTF-8
836 |
837 | # If the value of the INPUT tag contains directories, you can use the
838 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
839 | # *.h) to filter out the source-files in the directories.
840 | #
841 | # Note that for custom extensions or not directly supported extensions you also
842 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not
843 | # read by doxygen.
844 | #
845 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
846 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
847 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
848 | # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
849 | # *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen
850 | # C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
851 | # *.vhdl, *.ucf, *.qsf and *.ice.
852 |
853 | FILE_PATTERNS = *.c \
854 | *.h
855 |
856 | # The RECURSIVE tag can be used to specify whether or not subdirectories should
857 | # be searched for input files as well.
858 | # The default value is: NO.
859 |
860 | RECURSIVE = NO
861 |
862 | # The EXCLUDE tag can be used to specify files and/or directories that should be
863 | # excluded from the INPUT source files. This way you can easily exclude a
864 | # subdirectory from a directory tree whose root is specified with the INPUT tag.
865 | #
866 | # Note that relative paths are relative to the directory from which doxygen is
867 | # run.
868 |
869 | EXCLUDE =
870 |
871 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
872 | # directories that are symbolic links (a Unix file system feature) are excluded
873 | # from the input.
874 | # The default value is: NO.
875 |
876 | EXCLUDE_SYMLINKS = NO
877 |
878 | # If the value of the INPUT tag contains directories, you can use the
879 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
880 | # certain files from those directories.
881 | #
882 | # Note that the wildcards are matched against the file with absolute path, so to
883 | # exclude all test directories for example use the pattern */test/*
884 |
885 | EXCLUDE_PATTERNS =
886 |
887 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
888 | # (namespaces, classes, functions, etc.) that should be excluded from the
889 | # output. The symbol name can be a fully qualified name, a word, or if the
890 | # wildcard * is used, a substring. Examples: ANamespace, AClass,
891 | # AClass::ANamespace, ANamespace::*Test
892 | #
893 | # Note that the wildcards are matched against the file with absolute path, so to
894 | # exclude all test directories use the pattern */test/*
895 |
896 | EXCLUDE_SYMBOLS =
897 |
898 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories
899 | # that contain example code fragments that are included (see the \include
900 | # command).
901 |
902 | EXAMPLE_PATH =
903 |
904 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the
905 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
906 | # *.h) to filter out the source-files in the directories. If left blank all
907 | # files are included.
908 |
909 | EXAMPLE_PATTERNS = *
910 |
911 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
912 | # searched for input files to be used with the \include or \dontinclude commands
913 | # irrespective of the value of the RECURSIVE tag.
914 | # The default value is: NO.
915 |
916 | EXAMPLE_RECURSIVE = NO
917 |
918 | # The IMAGE_PATH tag can be used to specify one or more files or directories
919 | # that contain images that are to be included in the documentation (see the
920 | # \image command).
921 |
922 | IMAGE_PATH =
923 |
924 | # The INPUT_FILTER tag can be used to specify a program that doxygen should
925 | # invoke to filter for each input file. Doxygen will invoke the filter program
926 | # by executing (via popen()) the command:
927 | #
928 | #
929 | #
930 | # where is the value of the INPUT_FILTER tag, and is the
931 | # name of an input file. Doxygen will then use the output that the filter
932 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag
933 | # will be ignored.
934 | #
935 | # Note that the filter must not add or remove lines; it is applied before the
936 | # code is scanned, but not when the output code is generated. If lines are added
937 | # or removed, the anchors will not be placed correctly.
938 | #
939 | # Note that for custom extensions or not directly supported extensions you also
940 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not
941 | # properly processed by doxygen.
942 |
943 | INPUT_FILTER =
944 |
945 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
946 | # basis. Doxygen will compare the file name with each pattern and apply the
947 | # filter if there is a match. The filters are a list of the form: pattern=filter
948 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
949 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
950 | # patterns match the file name, INPUT_FILTER is applied.
951 | #
952 | # Note that for custom extensions or not directly supported extensions you also
953 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not
954 | # properly processed by doxygen.
955 |
956 | FILTER_PATTERNS =
957 |
958 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
959 | # INPUT_FILTER) will also be used to filter the input files that are used for
960 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
961 | # The default value is: NO.
962 |
963 | FILTER_SOURCE_FILES = NO
964 |
965 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
966 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
967 | # it is also possible to disable source filtering for a specific pattern using
968 | # *.ext= (so without naming a filter).
969 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
970 |
971 | FILTER_SOURCE_PATTERNS =
972 |
973 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
974 | # is part of the input, its contents will be placed on the main page
975 | # (index.html). This can be useful if you have a project on for instance GitHub
976 | # and want to reuse the introduction page also for the doxygen output.
977 |
978 | USE_MDFILE_AS_MAINPAGE =
979 |
980 | #---------------------------------------------------------------------------
981 | # Configuration options related to source browsing
982 | #---------------------------------------------------------------------------
983 |
984 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
985 | # generated. Documented entities will be cross-referenced with these sources.
986 | #
987 | # Note: To get rid of all source code in the generated output, make sure that
988 | # also VERBATIM_HEADERS is set to NO.
989 | # The default value is: NO.
990 |
991 | SOURCE_BROWSER = NO
992 |
993 | # Setting the INLINE_SOURCES tag to YES will include the body of functions,
994 | # classes and enums directly into the documentation.
995 | # The default value is: NO.
996 |
997 | INLINE_SOURCES = NO
998 |
999 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1000 | # special comment blocks from generated source code fragments. Normal C, C++ and
1001 | # Fortran comments will always remain visible.
1002 | # The default value is: YES.
1003 |
1004 | STRIP_CODE_COMMENTS = YES
1005 |
1006 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1007 | # entity all documented functions referencing it will be listed.
1008 | # The default value is: NO.
1009 |
1010 | REFERENCED_BY_RELATION = NO
1011 |
1012 | # If the REFERENCES_RELATION tag is set to YES then for each documented function
1013 | # all documented entities called/used by that function will be listed.
1014 | # The default value is: NO.
1015 |
1016 | REFERENCES_RELATION = NO
1017 |
1018 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1019 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1020 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1021 | # link to the documentation.
1022 | # The default value is: YES.
1023 |
1024 | REFERENCES_LINK_SOURCE = YES
1025 |
1026 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1027 | # source code will show a tooltip with additional information such as prototype,
1028 | # brief description and links to the definition and documentation. Since this
1029 | # will make the HTML file larger and loading of large files a bit slower, you
1030 | # can opt to disable this feature.
1031 | # The default value is: YES.
1032 | # This tag requires that the tag SOURCE_BROWSER is set to YES.
1033 |
1034 | SOURCE_TOOLTIPS = YES
1035 |
1036 | # If the USE_HTAGS tag is set to YES then the references to source code will
1037 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1038 | # source browser. The htags tool is part of GNU's global source tagging system
1039 | # (see https://www.gnu.org/software/global/global.html). You will need version
1040 | # 4.8.6 or higher.
1041 | #
1042 | # To use it do the following:
1043 | # - Install the latest version of global
1044 | # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1045 | # - Make sure the INPUT points to the root of the source tree
1046 | # - Run doxygen as normal
1047 | #
1048 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1049 | # tools must be available from the command line (i.e. in the search path).
1050 | #
1051 | # The result: instead of the source browser generated by doxygen, the links to
1052 | # source code will now point to the output of htags.
1053 | # The default value is: NO.
1054 | # This tag requires that the tag SOURCE_BROWSER is set to YES.
1055 |
1056 | USE_HTAGS = NO
1057 |
1058 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1059 | # verbatim copy of the header file for each class for which an include is
1060 | # specified. Set to NO to disable this.
1061 | # See also: Section \class.
1062 | # The default value is: YES.
1063 |
1064 | VERBATIM_HEADERS = YES
1065 |
1066 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1067 | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1068 | # cost of reduced performance. This can be particularly helpful with template
1069 | # rich C++ code for which doxygen's built-in parser lacks the necessary type
1070 | # information.
1071 | # Note: The availability of this option depends on whether or not doxygen was
1072 | # generated with the -Duse_libclang=ON option for CMake.
1073 | # The default value is: NO.
1074 |
1075 | CLANG_ASSISTED_PARSING = NO
1076 |
1077 | # If clang assisted parsing is enabled you can provide the compiler with command
1078 | # line options that you would normally use when invoking the compiler. Note that
1079 | # the include paths will already be set by doxygen for the files and directories
1080 | # specified with INPUT and INCLUDE_PATH.
1081 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1082 |
1083 | CLANG_OPTIONS =
1084 |
1085 | # If clang assisted parsing is enabled you can provide the clang parser with the
1086 | # path to the compilation database (see:
1087 | # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
1088 | # were built. This is equivalent to specifying the "-p" option to a clang tool,
1089 | # such as clang-check. These options will then be passed to the parser.
1090 | # Note: The availability of this option depends on whether or not doxygen was
1091 | # generated with the -Duse_libclang=ON option for CMake.
1092 |
1093 | CLANG_DATABASE_PATH =
1094 |
1095 | #---------------------------------------------------------------------------
1096 | # Configuration options related to the alphabetical class index
1097 | #---------------------------------------------------------------------------
1098 |
1099 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1100 | # compounds will be generated. Enable this if the project contains a lot of
1101 | # classes, structs, unions or interfaces.
1102 | # The default value is: YES.
1103 |
1104 | ALPHABETICAL_INDEX = YES
1105 |
1106 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1107 | # which the alphabetical index list will be split.
1108 | # Minimum value: 1, maximum value: 20, default value: 5.
1109 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1110 |
1111 | COLS_IN_ALPHA_INDEX = 5
1112 |
1113 | # In case all classes in a project start with a common prefix, all classes will
1114 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1115 | # can be used to specify a prefix (or a list of prefixes) that should be ignored
1116 | # while generating the index headers.
1117 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1118 |
1119 | IGNORE_PREFIX =
1120 |
1121 | #---------------------------------------------------------------------------
1122 | # Configuration options related to the HTML output
1123 | #---------------------------------------------------------------------------
1124 |
1125 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1126 | # The default value is: YES.
1127 |
1128 | GENERATE_HTML = YES
1129 |
1130 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1131 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1132 | # it.
1133 | # The default directory is: html.
1134 | # This tag requires that the tag GENERATE_HTML is set to YES.
1135 |
1136 | HTML_OUTPUT = docs
1137 |
1138 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1139 | # generated HTML page (for example: .htm, .php, .asp).
1140 | # The default value is: .html.
1141 | # This tag requires that the tag GENERATE_HTML is set to YES.
1142 |
1143 | HTML_FILE_EXTENSION = .html
1144 |
1145 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1146 | # each generated HTML page. If the tag is left blank doxygen will generate a
1147 | # standard header.
1148 | #
1149 | # To get valid HTML the header file that includes any scripts and style sheets
1150 | # that doxygen needs, which is dependent on the configuration options used (e.g.
1151 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1152 | # default header using
1153 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1154 | # YourConfigFile
1155 | # and then modify the file new_header.html. See also section "Doxygen usage"
1156 | # for information on how to generate the default header that doxygen normally
1157 | # uses.
1158 | # Note: The header is subject to change so you typically have to regenerate the
1159 | # default header when upgrading to a newer version of doxygen. For a description
1160 | # of the possible markers and block names see the documentation.
1161 | # This tag requires that the tag GENERATE_HTML is set to YES.
1162 |
1163 | HTML_HEADER =
1164 |
1165 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1166 | # generated HTML page. If the tag is left blank doxygen will generate a standard
1167 | # footer. See HTML_HEADER for more information on how to generate a default
1168 | # footer and what special commands can be used inside the footer. See also
1169 | # section "Doxygen usage" for information on how to generate the default footer
1170 | # that doxygen normally uses.
1171 | # This tag requires that the tag GENERATE_HTML is set to YES.
1172 |
1173 | HTML_FOOTER =
1174 |
1175 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1176 | # sheet that is used by each HTML page. It can be used to fine-tune the look of
1177 | # the HTML output. If left blank doxygen will generate a default style sheet.
1178 | # See also section "Doxygen usage" for information on how to generate the style
1179 | # sheet that doxygen normally uses.
1180 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1181 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1182 | # obsolete.
1183 | # This tag requires that the tag GENERATE_HTML is set to YES.
1184 |
1185 | HTML_STYLESHEET =
1186 |
1187 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1188 | # cascading style sheets that are included after the standard style sheets
1189 | # created by doxygen. Using this option one can overrule certain style aspects.
1190 | # This is preferred over using HTML_STYLESHEET since it does not replace the
1191 | # standard style sheet and is therefore more robust against future updates.
1192 | # Doxygen will copy the style sheet files to the output directory.
1193 | # Note: The order of the extra style sheet files is of importance (e.g. the last
1194 | # style sheet in the list overrules the setting of the previous ones in the
1195 | # list). For an example see the documentation.
1196 | # This tag requires that the tag GENERATE_HTML is set to YES.
1197 |
1198 | HTML_EXTRA_STYLESHEET =
1199 |
1200 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1201 | # other source files which should be copied to the HTML output directory. Note
1202 | # that these files will be copied to the base HTML output directory. Use the
1203 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1204 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1205 | # files will be copied as-is; there are no commands or markers available.
1206 | # This tag requires that the tag GENERATE_HTML is set to YES.
1207 |
1208 | HTML_EXTRA_FILES =
1209 |
1210 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1211 | # will adjust the colors in the style sheet and background images according to
1212 | # this color. Hue is specified as an angle on a colorwheel, see
1213 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1214 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1215 | # purple, and 360 is red again.
1216 | # Minimum value: 0, maximum value: 359, default value: 220.
1217 | # This tag requires that the tag GENERATE_HTML is set to YES.
1218 |
1219 | HTML_COLORSTYLE_HUE = 220
1220 |
1221 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1222 | # in the HTML output. For a value of 0 the output will use grayscales only. A
1223 | # value of 255 will produce the most vivid colors.
1224 | # Minimum value: 0, maximum value: 255, default value: 100.
1225 | # This tag requires that the tag GENERATE_HTML is set to YES.
1226 |
1227 | HTML_COLORSTYLE_SAT = 100
1228 |
1229 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1230 | # luminance component of the colors in the HTML output. Values below 100
1231 | # gradually make the output lighter, whereas values above 100 make the output
1232 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1233 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1234 | # change the gamma.
1235 | # Minimum value: 40, maximum value: 240, default value: 80.
1236 | # This tag requires that the tag GENERATE_HTML is set to YES.
1237 |
1238 | HTML_COLORSTYLE_GAMMA = 80
1239 |
1240 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1241 | # page will contain the date and time when the page was generated. Setting this
1242 | # to YES can help to show when doxygen was last run and thus if the
1243 | # documentation is up to date.
1244 | # The default value is: NO.
1245 | # This tag requires that the tag GENERATE_HTML is set to YES.
1246 |
1247 | HTML_TIMESTAMP = NO
1248 |
1249 | # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1250 | # documentation will contain a main index with vertical navigation menus that
1251 | # are dynamically created via JavaScript. If disabled, the navigation index will
1252 | # consists of multiple levels of tabs that are statically embedded in every HTML
1253 | # page. Disable this option to support browsers that do not have JavaScript,
1254 | # like the Qt help browser.
1255 | # The default value is: YES.
1256 | # This tag requires that the tag GENERATE_HTML is set to YES.
1257 |
1258 | HTML_DYNAMIC_MENUS = YES
1259 |
1260 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1261 | # documentation will contain sections that can be hidden and shown after the
1262 | # page has loaded.
1263 | # The default value is: NO.
1264 | # This tag requires that the tag GENERATE_HTML is set to YES.
1265 |
1266 | HTML_DYNAMIC_SECTIONS = NO
1267 |
1268 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1269 | # shown in the various tree structured indices initially; the user can expand
1270 | # and collapse entries dynamically later on. Doxygen will expand the tree to
1271 | # such a level that at most the specified number of entries are visible (unless
1272 | # a fully collapsed tree already exceeds this amount). So setting the number of
1273 | # entries 1 will produce a full collapsed tree by default. 0 is a special value
1274 | # representing an infinite number of entries and will result in a full expanded
1275 | # tree by default.
1276 | # Minimum value: 0, maximum value: 9999, default value: 100.
1277 | # This tag requires that the tag GENERATE_HTML is set to YES.
1278 |
1279 | HTML_INDEX_NUM_ENTRIES = 100
1280 |
1281 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1282 | # generated that can be used as input for Apple's Xcode 3 integrated development
1283 | # environment (see: https://developer.apple.com/xcode/), introduced with OSX
1284 | # 10.5 (Leopard). To create a documentation set, doxygen will generate a
1285 | # Makefile in the HTML output directory. Running make will produce the docset in
1286 | # that directory and running make install will install the docset in
1287 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1288 | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1289 | # genXcode/_index.html for more information.
1290 | # The default value is: NO.
1291 | # This tag requires that the tag GENERATE_HTML is set to YES.
1292 |
1293 | GENERATE_DOCSET = NO
1294 |
1295 | # This tag determines the name of the docset feed. A documentation feed provides
1296 | # an umbrella under which multiple documentation sets from a single provider
1297 | # (such as a company or product suite) can be grouped.
1298 | # The default value is: Doxygen generated docs.
1299 | # This tag requires that the tag GENERATE_DOCSET is set to YES.
1300 |
1301 | DOCSET_FEEDNAME = "Doxygen generated docs"
1302 |
1303 | # This tag specifies a string that should uniquely identify the documentation
1304 | # set bundle. This should be a reverse domain-name style string, e.g.
1305 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1306 | # The default value is: org.doxygen.Project.
1307 | # This tag requires that the tag GENERATE_DOCSET is set to YES.
1308 |
1309 | DOCSET_BUNDLE_ID = org.doxygen.Project
1310 |
1311 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1312 | # the documentation publisher. This should be a reverse domain-name style
1313 | # string, e.g. com.mycompany.MyDocSet.documentation.
1314 | # The default value is: org.doxygen.Publisher.
1315 | # This tag requires that the tag GENERATE_DOCSET is set to YES.
1316 |
1317 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1318 |
1319 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1320 | # The default value is: Publisher.
1321 | # This tag requires that the tag GENERATE_DOCSET is set to YES.
1322 |
1323 | DOCSET_PUBLISHER_NAME = Publisher
1324 |
1325 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1326 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1327 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1328 | # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1329 | # Windows.
1330 | #
1331 | # The HTML Help Workshop contains a compiler that can convert all HTML output
1332 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1333 | # files are now used as the Windows 98 help format, and will replace the old
1334 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1335 | # HTML files also contain an index, a table of contents, and you can search for
1336 | # words in the documentation. The HTML workshop also contains a viewer for
1337 | # compressed HTML files.
1338 | # The default value is: NO.
1339 | # This tag requires that the tag GENERATE_HTML is set to YES.
1340 |
1341 | GENERATE_HTMLHELP = NO
1342 |
1343 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1344 | # file. You can add a path in front of the file if the result should not be
1345 | # written to the html output directory.
1346 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1347 |
1348 | CHM_FILE =
1349 |
1350 | # The HHC_LOCATION tag can be used to specify the location (absolute path
1351 | # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1352 | # doxygen will try to run the HTML help compiler on the generated index.hhp.
1353 | # The file has to be specified with full path.
1354 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1355 |
1356 | HHC_LOCATION =
1357 |
1358 | # The GENERATE_CHI flag controls if a separate .chi index file is generated
1359 | # (YES) or that it should be included in the master .chm file (NO).
1360 | # The default value is: NO.
1361 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1362 |
1363 | GENERATE_CHI = NO
1364 |
1365 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1366 | # and project file content.
1367 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1368 |
1369 | CHM_INDEX_ENCODING =
1370 |
1371 | # The BINARY_TOC flag controls whether a binary table of contents is generated
1372 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1373 | # enables the Previous and Next buttons.
1374 | # The default value is: NO.
1375 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1376 |
1377 | BINARY_TOC = NO
1378 |
1379 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1380 | # the table of contents of the HTML help documentation and to the tree view.
1381 | # The default value is: NO.
1382 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1383 |
1384 | TOC_EXPAND = NO
1385 |
1386 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1387 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1388 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1389 | # (.qch) of the generated HTML documentation.
1390 | # The default value is: NO.
1391 | # This tag requires that the tag GENERATE_HTML is set to YES.
1392 |
1393 | GENERATE_QHP = NO
1394 |
1395 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1396 | # the file name of the resulting .qch file. The path specified is relative to
1397 | # the HTML output folder.
1398 | # This tag requires that the tag GENERATE_QHP is set to YES.
1399 |
1400 | QCH_FILE =
1401 |
1402 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1403 | # Project output. For more information please see Qt Help Project / Namespace
1404 | # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1405 | # The default value is: org.doxygen.Project.
1406 | # This tag requires that the tag GENERATE_QHP is set to YES.
1407 |
1408 | QHP_NAMESPACE = org.doxygen.Project
1409 |
1410 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1411 | # Help Project output. For more information please see Qt Help Project / Virtual
1412 | # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
1413 | # folders).
1414 | # The default value is: doc.
1415 | # This tag requires that the tag GENERATE_QHP is set to YES.
1416 |
1417 | QHP_VIRTUAL_FOLDER = doc
1418 |
1419 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1420 | # filter to add. For more information please see Qt Help Project / Custom
1421 | # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1422 | # filters).
1423 | # This tag requires that the tag GENERATE_QHP is set to YES.
1424 |
1425 | QHP_CUST_FILTER_NAME =
1426 |
1427 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1428 | # custom filter to add. For more information please see Qt Help Project / Custom
1429 | # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1430 | # filters).
1431 | # This tag requires that the tag GENERATE_QHP is set to YES.
1432 |
1433 | QHP_CUST_FILTER_ATTRS =
1434 |
1435 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1436 | # project's filter section matches. Qt Help Project / Filter Attributes (see:
1437 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1438 | # This tag requires that the tag GENERATE_QHP is set to YES.
1439 |
1440 | QHP_SECT_FILTER_ATTRS =
1441 |
1442 | # The QHG_LOCATION tag can be used to specify the location of Qt's
1443 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1444 | # generated .qhp file.
1445 | # This tag requires that the tag GENERATE_QHP is set to YES.
1446 |
1447 | QHG_LOCATION =
1448 |
1449 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1450 | # generated, together with the HTML files, they form an Eclipse help plugin. To
1451 | # install this plugin and make it available under the help contents menu in
1452 | # Eclipse, the contents of the directory containing the HTML and XML files needs
1453 | # to be copied into the plugins directory of eclipse. The name of the directory
1454 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1455 | # After copying Eclipse needs to be restarted before the help appears.
1456 | # The default value is: NO.
1457 | # This tag requires that the tag GENERATE_HTML is set to YES.
1458 |
1459 | GENERATE_ECLIPSEHELP = NO
1460 |
1461 | # A unique identifier for the Eclipse help plugin. When installing the plugin
1462 | # the directory name containing the HTML and XML files should also have this
1463 | # name. Each documentation set should have its own identifier.
1464 | # The default value is: org.doxygen.Project.
1465 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1466 |
1467 | ECLIPSE_DOC_ID = org.doxygen.Project
1468 |
1469 | # If you want full control over the layout of the generated HTML pages it might
1470 | # be necessary to disable the index and replace it with your own. The
1471 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1472 | # of each HTML page. A value of NO enables the index and the value YES disables
1473 | # it. Since the tabs in the index contain the same information as the navigation
1474 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1475 | # The default value is: NO.
1476 | # This tag requires that the tag GENERATE_HTML is set to YES.
1477 |
1478 | DISABLE_INDEX = NO
1479 |
1480 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1481 | # structure should be generated to display hierarchical information. If the tag
1482 | # value is set to YES, a side panel will be generated containing a tree-like
1483 | # index structure (just like the one that is generated for HTML Help). For this
1484 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1485 | # (i.e. any modern browser). Windows users are probably better off using the
1486 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1487 | # further fine-tune the look of the index. As an example, the default style
1488 | # sheet generated by doxygen has an example that shows how to put an image at
1489 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1490 | # the same information as the tab index, you could consider setting
1491 | # DISABLE_INDEX to YES when enabling this option.
1492 | # The default value is: NO.
1493 | # This tag requires that the tag GENERATE_HTML is set to YES.
1494 |
1495 | GENERATE_TREEVIEW = NO
1496 |
1497 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1498 | # doxygen will group on one line in the generated HTML documentation.
1499 | #
1500 | # Note that a value of 0 will completely suppress the enum values from appearing
1501 | # in the overview section.
1502 | # Minimum value: 0, maximum value: 20, default value: 4.
1503 | # This tag requires that the tag GENERATE_HTML is set to YES.
1504 |
1505 | ENUM_VALUES_PER_LINE = 4
1506 |
1507 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1508 | # to set the initial width (in pixels) of the frame in which the tree is shown.
1509 | # Minimum value: 0, maximum value: 1500, default value: 250.
1510 | # This tag requires that the tag GENERATE_HTML is set to YES.
1511 |
1512 | TREEVIEW_WIDTH = 250
1513 |
1514 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1515 | # external symbols imported via tag files in a separate window.
1516 | # The default value is: NO.
1517 | # This tag requires that the tag GENERATE_HTML is set to YES.
1518 |
1519 | EXT_LINKS_IN_WINDOW = NO
1520 |
1521 | # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1522 | # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1523 | # https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1524 | # the HTML output. These images will generally look nicer at scaled resolutions.
1525 | # Possible values are: png The default and svg Looks nicer but requires the
1526 | # pdf2svg tool.
1527 | # The default value is: png.
1528 | # This tag requires that the tag GENERATE_HTML is set to YES.
1529 |
1530 | HTML_FORMULA_FORMAT = png
1531 |
1532 | # Use this tag to change the font size of LaTeX formulas included as images in
1533 | # the HTML documentation. When you change the font size after a successful
1534 | # doxygen run you need to manually remove any form_*.png images from the HTML
1535 | # output directory to force them to be regenerated.
1536 | # Minimum value: 8, maximum value: 50, default value: 10.
1537 | # This tag requires that the tag GENERATE_HTML is set to YES.
1538 |
1539 | FORMULA_FONTSIZE = 10
1540 |
1541 | # Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1542 | # generated for formulas are transparent PNGs. Transparent PNGs are not
1543 | # supported properly for IE 6.0, but are supported on all modern browsers.
1544 | #
1545 | # Note that when changing this option you need to delete any form_*.png files in
1546 | # the HTML output directory before the changes have effect.
1547 | # The default value is: YES.
1548 | # This tag requires that the tag GENERATE_HTML is set to YES.
1549 |
1550 | FORMULA_TRANSPARENT = YES
1551 |
1552 | # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1553 | # to create new LaTeX commands to be used in formulas as building blocks. See
1554 | # the section "Including formulas" for details.
1555 |
1556 | FORMULA_MACROFILE =
1557 |
1558 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1559 | # https://www.mathjax.org) which uses client side JavaScript for the rendering
1560 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1561 | # installed or if you want to formulas look prettier in the HTML output. When
1562 | # enabled you may also need to install MathJax separately and configure the path
1563 | # to it using the MATHJAX_RELPATH option.
1564 | # The default value is: NO.
1565 | # This tag requires that the tag GENERATE_HTML is set to YES.
1566 |
1567 | USE_MATHJAX = NO
1568 |
1569 | # When MathJax is enabled you can set the default output format to be used for
1570 | # the MathJax output. See the MathJax site (see:
1571 | # http://docs.mathjax.org/en/latest/output.html) for more details.
1572 | # Possible values are: HTML-CSS (which is slower, but has the best
1573 | # compatibility), NativeMML (i.e. MathML) and SVG.
1574 | # The default value is: HTML-CSS.
1575 | # This tag requires that the tag USE_MATHJAX is set to YES.
1576 |
1577 | MATHJAX_FORMAT = HTML-CSS
1578 |
1579 | # When MathJax is enabled you need to specify the location relative to the HTML
1580 | # output directory using the MATHJAX_RELPATH option. The destination directory
1581 | # should contain the MathJax.js script. For instance, if the mathjax directory
1582 | # is located at the same level as the HTML output directory, then
1583 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1584 | # Content Delivery Network so you can quickly see the result without installing
1585 | # MathJax. However, it is strongly recommended to install a local copy of
1586 | # MathJax from https://www.mathjax.org before deployment.
1587 | # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
1588 | # This tag requires that the tag USE_MATHJAX is set to YES.
1589 |
1590 | MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2
1591 |
1592 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1593 | # extension names that should be enabled during MathJax rendering. For example
1594 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1595 | # This tag requires that the tag USE_MATHJAX is set to YES.
1596 |
1597 | MATHJAX_EXTENSIONS =
1598 |
1599 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1600 | # of code that will be used on startup of the MathJax code. See the MathJax site
1601 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1602 | # example see the documentation.
1603 | # This tag requires that the tag USE_MATHJAX is set to YES.
1604 |
1605 | MATHJAX_CODEFILE =
1606 |
1607 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1608 | # the HTML output. The underlying search engine uses javascript and DHTML and
1609 | # should work on any modern browser. Note that when using HTML help
1610 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1611 | # there is already a search function so this one should typically be disabled.
1612 | # For large projects the javascript based search engine can be slow, then
1613 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1614 | # search using the keyboard; to jump to the search box use + S
1615 | # (what the is depends on the OS and browser, but it is typically
1616 | # , /