├── .github └── workflows │ ├── deploy.yml │ ├── deploy_to_pypi.yml │ ├── docs-publish.yml │ └── docs-verify.yml ├── .gitignore ├── .gitmodules ├── .travis.yml ├── LICENSE ├── README.md ├── brping ├── __init__.py └── pingmessage.py ├── ci ├── ci-functions.sh ├── deploy-gh-pages.sh ├── deploy-whitelist ├── deploy.sh └── travis-ci-script.sh ├── doc ├── .gitignore ├── Doxyfile └── ping.png ├── docs ├── .gitignore ├── Makefile ├── poetry.lock ├── pyproject.toml ├── source │ ├── _static │ │ ├── .gitkeep │ │ └── custom.css │ ├── conf.py │ ├── index.rst │ └── python_api │ │ └── index.rst └── versions.json ├── examples ├── ping360AutoScan.py └── simplePingExample.py ├── generate ├── generate-python.py └── templates │ ├── device.py.in │ ├── ping1d.py.in │ ├── ping360.py.in │ └── pingmessage-definitions.py.in ├── setup.py └── tools ├── ping1d-simulation.py └── pingproxy.py /.github/workflows/deploy.yml: -------------------------------------------------------------------------------- 1 | name: Deployment Workflow 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | 8 | jobs: 9 | deploy: 10 | runs-on: ubuntu-latest 11 | 12 | steps: 13 | - name: Checkout Code 14 | uses: actions/checkout@v2 15 | with: 16 | submodules: recursive 17 | 18 | - name: Setup Environment 19 | run: | 20 | pip install jinja2 21 | generate/generate-python.py --output-dir=brping 22 | git config remote.origin.fetch "+refs/heads/*:refs/remotes/origin/*" 23 | git fetch origin deployment 24 | git config user.email "support@bluerobotics.com" 25 | git config user.name "BlueRobotics-CI" 26 | 27 | - name: install and test 28 | run: | 29 | echo "installing package..." 30 | pip install . --user 31 | 32 | echo "testing message api..." 33 | python brping/pingmessage.py 34 | 35 | 36 | - name: Generate and Commit Files 37 | run: | 38 | ci/deploy.sh 39 | 40 | - name: Commit Changes 41 | run: | 42 | git commit -m "update autogenerated files for $(git rev-parse HEAD@{2})" || exit 0 43 | 44 | - name: Push changes 45 | uses: ad-m/github-push-action@master 46 | with: 47 | github_token: ${{ secrets.GITHUB_TOKEN }} 48 | branch: deployment 49 | -------------------------------------------------------------------------------- /.github/workflows/deploy_to_pypi.yml: -------------------------------------------------------------------------------- 1 | name: Deploy to PyPI 2 | 3 | on: 4 | push: 5 | tags: 6 | - 'v*.*.*' # This will trigger the workflow only when a tag that matches the pattern is pushed 7 | 8 | permissions: 9 | id-token: write 10 | 11 | jobs: 12 | deploy: 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - name: Checkout Code 17 | uses: actions/checkout@v2 18 | with: 19 | submodules: recursive 20 | 21 | - name: Set up Python 22 | uses: actions/setup-python@v2 23 | with: 24 | python-version: '3.x' 25 | 26 | - name: Check Tag and setup.py Version Match 27 | run: | 28 | TAG_VERSION=${GITHUB_REF#refs/tags/v} 29 | SETUP_VERSION=$(grep -oE "version='([^']+)" setup.py | grep -oE "[^'=]+$") 30 | if [[ "$TAG_VERSION" != "$SETUP_VERSION" ]]; then 31 | echo "Tag version $TAG_VERSION does not match setup.py version $SETUP_VERSION." 32 | exit 1 33 | fi 34 | 35 | - name: Install dependencies 36 | run: | 37 | python -m pip install --upgrade pip 38 | pip install jinja2 setuptools wheel 39 | generate/generate-python.py --output-dir=brping 40 | 41 | - name: Build package 42 | run: | 43 | python setup.py sdist bdist_wheel 44 | 45 | - name: Publish package distributions to PyPI 46 | uses: pypa/gh-action-pypi-publish@release/v1 47 | with: 48 | packages-dir: ./dist 49 | -------------------------------------------------------------------------------- /.github/workflows/docs-publish.yml: -------------------------------------------------------------------------------- 1 | name: "Publish documentation" 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | paths: 8 | - docs/** 9 | workflow_dispatch: 10 | inputs: 11 | branch: 12 | description: 'Branch to build (leave empty to build all versions)' 13 | required: false 14 | type: string 15 | 16 | jobs: 17 | # Load versions configuration from the default branch 18 | prepare: 19 | runs-on: ubuntu-latest 20 | outputs: 21 | versions: ${{ steps.set-matrix.outputs.versions }} 22 | default_version: ${{ steps.set-matrix.outputs.default_version }} 23 | multiversion_enabled: ${{ steps.set-matrix.outputs.multiversion_enabled }} 24 | event_branch: ${{ steps.set-matrix.outputs.event_branch }} 25 | steps: 26 | - uses: actions/checkout@v4 27 | with: 28 | ref: ${{ github.event.repository.default_branch }} 29 | 30 | - id: set-matrix 31 | run: | 32 | content=$(cd docs && cat versions.json) 33 | 34 | # Extract versions from versions.json 35 | versions=$(echo "$content" | jq -c '.versions') 36 | echo "versions=$versions" >> $GITHUB_OUTPUT 37 | 38 | # Extract default version 39 | default_version=$(echo "$content" | jq -r '.versions[] | select(.is_default == true) | .name') 40 | echo "default_version=$default_version" >> $GITHUB_OUTPUT 41 | 42 | # Check if multi-version is enabled 43 | version_count=$(echo "$content" | jq '.versions | length') 44 | if [[ $version_count -gt 1 ]]; then 45 | echo "multiversion_enabled=true" >> $GITHUB_OUTPUT 46 | else 47 | echo "multiversion_enabled=false" >> $GITHUB_OUTPUT 48 | fi 49 | 50 | # Set event_branch 51 | event_branch="" 52 | if [[ "${{ github.event_name }}" == "push" ]]; then 53 | event_branch="${{ github.ref_name }}" 54 | elif [[ "${{ github.event_name }}" == "workflow_dispatch" ]] && [ -n "${{ github.event.inputs.branch }}" ]; then 55 | event_branch="${{ github.event.inputs.branch }}" 56 | fi 57 | echo "event_branch=$event_branch" >> $GITHUB_OUTPUT 58 | 59 | # If event_branch is defined, check if it exists in versions.json 60 | if [ -n "$event_branch" ]; then 61 | # Check if the branch exists in the versions.json 62 | branch_exists=$(echo "$content" | jq -r --arg branch "$event_branch" '.versions[] | select(.branch == $branch) | .branch') 63 | if [ -z "$branch_exists" ]; then 64 | echo "error: Branch $event_branch not found in versions.json" >&2 65 | exit 1 66 | fi 67 | # If branch exists, filter out only that version 68 | filtered_versions=$(echo "$content" | jq --arg branch "$event_branch" -c '[.versions[] | select(.branch == $branch)]') 69 | echo "versions=$filtered_versions" >> $GITHUB_OUTPUT 70 | fi 71 | 72 | - name: Debug set-matrix output 73 | run: | 74 | echo "Versions: ${{ steps.set-matrix.outputs.versions }}" 75 | echo "Default Version: ${{ steps.set-matrix.outputs.default_version }}" 76 | echo "Multiversion Enabled: ${{ steps.set-matrix.outputs.multiversion_enabled }}" 77 | echo "Event Branch: ${{ steps.set-matrix.outputs.event_branch }}" 78 | 79 | - name: Save versions.json to artifact 80 | run: | 81 | mkdir -p /tmp/versions 82 | cp docs/versions.json /tmp/versions/versions.json 83 | 84 | - name: Upload versions.json artifact 85 | uses: actions/upload-artifact@v4 86 | with: 87 | name: versions-json 88 | path: /tmp/versions/ 89 | 90 | # Build all docs 91 | build: 92 | needs: prepare 93 | runs-on: ubuntu-latest 94 | strategy: 95 | matrix: 96 | version: ${{ fromJson(needs.prepare.outputs.versions) }} 97 | fail-fast: false 98 | steps: 99 | - uses: actions/checkout@v4 100 | with: 101 | ref: ${{ matrix.version.branch }} 102 | 103 | - name: Download versions.json artifact 104 | uses: actions/download-artifact@v4 105 | with: 106 | name: versions-json 107 | path: /tmp/versions/ 108 | 109 | - name: Override versions.json 110 | run: cp /tmp/versions/versions.json docs/versions.json 111 | 112 | - name: Set up Python 113 | uses: actions/setup-python@v5 114 | with: 115 | python-version: '3.12' 116 | 117 | - name: Install Doxygen (optional) 118 | run: sudo apt-get update && sudo apt-get install -y doxygen 119 | 120 | - name: Install dependencies 121 | run: make -C docs setupenv 122 | 123 | - name: Build docs 124 | env: 125 | MULTIVERSION_CURRENT_NAME: ${{ matrix.version.name }} 126 | MULTIVERSION_CURRENT_BRANCH: ${{ matrix.version.branch }} 127 | MULTIVERSION_ENABLED: ${{ needs.prepare.outputs.multiversion_enabled }} 128 | run: | 129 | output_dir="${{ matrix.version.name }}" 130 | make -C docs dirhtml BUILDDIR="_build/$output_dir" 131 | 132 | - name: Save build output to artifact 133 | run: | 134 | mkdir -p /tmp/build-output 135 | cp -r docs/_build/${{ matrix.version.name }}/dirhtml/* /tmp/build-output/ 136 | 137 | - name: Upload build output artifact 138 | uses: actions/upload-artifact@v4 139 | with: 140 | name: build-output-${{ matrix.version.name }} 141 | path: /tmp/build-output 142 | 143 | # Deploy to gh-pages branch 144 | deploy: 145 | needs: [prepare, build] 146 | runs-on: ubuntu-latest 147 | steps: 148 | - name: Checkout gh-pages branch 149 | uses: actions/checkout@v4 150 | with: 151 | ref: gh-pages 152 | 153 | - name: Download all build output artifacts 154 | uses: actions/download-artifact@v4 155 | with: 156 | path: /tmp/build-output 157 | 158 | - name: Replace folder if only one version was built 159 | if: ${{ needs.prepare.outputs.event_branch != '' }} 160 | run: | 161 | version_name=$(echo '${{ needs.prepare.outputs.versions }}' | jq -r '.[0].name') 162 | rm -rf $version_name 163 | mkdir -p $version_name 164 | cp -r /tmp/build-output/build-output-$version_name/* $version_name/ 165 | 166 | - name: Clear all and replace folders if multiple versions were built 167 | if: ${{ needs.prepare.outputs.event_branch == '' }} 168 | run: | 169 | versions_json='${{ needs.prepare.outputs.versions }}' 170 | rm -rf * 171 | for version in $(echo "$versions_json" | jq -c '.[]'); do 172 | version_name=$(echo "$version" | jq -r '.name') 173 | mkdir -p $version_name 174 | cp -r /tmp/build-output/build-output-$version_name/* $version_name/ 175 | done 176 | 177 | - name: Create redirect to default version 178 | env: 179 | DEFAULT_VERSION: ${{ needs.prepare.outputs.default_version }} 180 | run: | 181 | cat > index.html << EOF 182 | 183 | 184 | 185 | 186 | 187 | 188 | EOF 189 | 190 | - name: Create .nojekyll 191 | run: touch .nojekyll 192 | 193 | - name: Commit and push changes 194 | run: | 195 | git config user.name "GitHub Actions" 196 | git config user.email "actions@github.com" 197 | git add . 198 | git commit -m "Update documentation" 199 | git push origin gh-pages -------------------------------------------------------------------------------- /.github/workflows/docs-verify.yml: -------------------------------------------------------------------------------- 1 | name: "Test documentation" 2 | 3 | on: 4 | pull_request: 5 | branches: 6 | - master 7 | paths: 8 | - "docs/**" 9 | 10 | jobs: 11 | build: 12 | runs-on: ubuntu-latest 13 | steps: 14 | - name: Checkout 15 | uses: actions/checkout@v4 16 | with: 17 | persist-credentials: false 18 | fetch-depth: 0 19 | - name: Set up Python 20 | uses: actions/setup-python@v5 21 | with: 22 | python-version: '3.12' 23 | 24 | - name: Install dependencies 25 | run: make -C docs setupenv 26 | 27 | - name: Install Doxygen (optional) 28 | run: sudo apt-get update && sudo apt-get install -y doxygen 29 | 30 | - name: Build docs 31 | run: make -C docs test BUILDDIR="_build/$output_dir" 32 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | **__pycache__ 2 | *.pyc 3 | dist 4 | bluerobotics_ping.egg-info 5 | build 6 | brping/definitions.py 7 | brping/device.py 8 | brping/ping1d.py 9 | brping/ping360.py 10 | doc/xml 11 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "lib/ping-protocol"] 2 | path = lib/ping-protocol 3 | url = https://github.com/bluerobotics/ping-protocol 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | dist: xenial 2 | 3 | language: python 4 | 5 | addons: 6 | apt: 7 | packages: 8 | - doxygen 9 | - graphviz 10 | 11 | deploy: 12 | provider: pypi 13 | user: __token__ 14 | distributions: sdist 15 | password: $PYPI_TOKEN 16 | on: 17 | tags: true 18 | condition: $TRAVIS_TAG =~ v[0-9]+.[0-9]+.[0-9]+.* && $(if grep -q "${BASH_REMATCH:1}" "$TRAVIS_BUILD_DIR/setup.py"; then echo 0; fi) 19 | 20 | script: 21 | - ci/travis-ci-script.sh || travis_terminate 1 22 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2016 Blue Robotics 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ping-python 2 | 3 | 4 | 5 | 6 | 7 | [![Travis Build Status](https://travis-ci.org/bluerobotics/ping-python.svg?branch=master)](https://travis-ci.org/bluerobotics/ping-python) 8 | [![Gitter](https://img.shields.io/badge/gitter-online-green.svg)](https://gitter.im/bluerobotics/discussion/) 9 | [![PyPI version](https://badge.fury.io/py/bluerobotics-ping.svg)](https://badge.fury.io/py/bluerobotics-ping) 10 | 11 | Python library for the Ping sonar. Ping is the simple, affordable, and compact ultrasonic altimeter for any aquatic project. 12 | 13 | This library exposes all functionality of the device, such as getting profiles, controlling parameters, switching modes, or just simply reading in the distance measurement. 14 | 15 | [Available here](https://www.bluerobotics.com/store/sensors-sonars-cameras/sonar/ping-sonar-r2-rp/) 16 | 17 |
18 |
19 | 20 | ## Resources 21 | 22 | * [API Reference](https://docs.bluerobotics.com/ping-python/) 23 | * [Device Specifications](https://www.bluerobotics.com/store/sensors-sonars-cameras/sonar/ping-sonar-r2-rp/#tab-technical-details) 24 | * [Communication Protocol](https://github.com/bluerobotics/ping-protocol) 25 | * [Support](https://gitter.im/bluerobotics/discussion) 26 | * [License](https://github.com/bluerobotics/ping-python/blob/master/LICENSE) 27 | 28 | 29 | ## Installing 30 | 31 | ### pip 32 | 33 | ```sh 34 | $ pip install --user bluerobotics-ping --upgrade 35 | ``` 36 | 37 | ### From source 38 | 39 | ```sh 40 | $ git clone --single-branch --branch deployment https://github.com/bluerobotics/ping-python.git 41 | $ cd ping-python 42 | $ python setup.py install --user 43 | ``` 44 | 45 | The library is ready to use: `import brping`. If you would like to use the command line [examples](/examples) or [tools](/tools) provided by this package, follow the notes in python's [installing to user site](https://packaging.python.org/tutorials/installing-packages/#installing-to-the-user-site) directions (eg `export PATH=$PATH:~/.local/bin`). 46 | 47 | #### From master branch 48 | 49 | If you wish to build from scratch the project using master branch or wip pull requests to test, you should compile and generate the definitions file: 50 | 51 | ```sh 52 | $ git clone https://github.com/bluerobotics/ping-python.git 53 | $ pip install jinja2 54 | $ cd ping-python 55 | $ git submodule update --init 56 | $ python generate/generate-python.py --output-dir=brping 57 | $ python setup.py install --user 58 | $ python -c "import brping" # It works! 59 | ``` 60 | 61 | ## Quick Start 62 | 63 | The `bluerobotics-ping` package installs a `simplePingExample.py` script to get started. Place your device's file descriptor (eg. `/dev/ttyUSB0`, `COM1`) after the --device option. 64 | 65 | `$ simplePingExample.py --device ` 66 | 67 | It's also possible to connect via UDP server using the `--udp` option with IP:PORT as input (e.g `192.168.2.2:9090`). 68 | 69 | ## Usage 70 | 71 | The [Ping1D](https://docs.bluerobotics.com/ping-python/classPing_1_1Ping1D_1_1Ping1D.html) class provides an easy interface to configure a Ping device and retrieve data. 72 | 73 | A Ping1D object must be initialized with the serial device path and the baudrate. 74 | 75 | ```py 76 | from brping import Ping1D 77 | myPing = Ping1D() 78 | myPing.connect_serial("/dev/ttyUSB0", 115200) 79 | # For UDP 80 | # myPing.connect_udp("192.168.2.2", 9090) 81 | ``` 82 | 83 | Call initialize() to establish communications with the device. 84 | 85 | ```py 86 | if myPing.initialize() is False: 87 | print("Failed to initialize Ping!") 88 | exit(1) 89 | ``` 90 | 91 | Use [`get_`](https://github.com/bluerobotics/ping-protocol#get) to request data from the device. The data is returned as a dictionary with keys matching the names of the message payload fields. The messages you may request are documented in the [ping-protocol](https://github.com/bluerobotics/ping-protocol). 92 | 93 | ```py 94 | data = myPing.get_distance() 95 | if data: 96 | print("Distance: %s\tConfidence: %s%%" % (data["distance"], data["confidence"])) 97 | else: 98 | print("Failed to get distance data") 99 | ``` 100 | 101 | Use the [`set_*`](https://github.com/bluerobotics/ping-protocol#set) messages (eg. [set_speed_of_sound()](https://docs.bluerobotics.com/ping-python/classPing_1_1Ping1D_1_1Ping1D.html#a79a3931e5564644187198ad2063e5ed9)) to change settings on the Ping device. 102 | 103 | ```py 104 | # set the speed of sound to use for distance calculations to 105 | # 1450000 mm/s (1450 m/s) 106 | myPing.set_speed_of_sound(1450000) 107 | ``` 108 | 109 | See the [doxygen](https://docs.bluerobotics.com/ping-python/) documentation for complete API documentation. 110 | -------------------------------------------------------------------------------- /brping/__init__.py: -------------------------------------------------------------------------------- 1 | #'Ping python package' 2 | from brping.definitions import * 3 | from brping.pingmessage import * 4 | from brping.device import PingDevice 5 | from brping.ping1d import Ping1D 6 | from brping.ping360 import Ping360 7 | -------------------------------------------------------------------------------- /brping/pingmessage.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | # PingMessage.py 4 | # Python implementation of the Blue Robotics 'Ping' binary message protocol 5 | 6 | import struct 7 | from brping import definitions 8 | payload_dict = definitions.payload_dict_all 9 | asciiMsgs = [definitions.COMMON_NACK, definitions.COMMON_ASCII_TEXT] 10 | variable_msgs = [ 11 | definitions.PING1D_PROFILE, 12 | definitions.PING360_DEVICE_DATA, 13 | definitions.PING360_AUTO_DEVICE_DATA, 14 | ] 15 | 16 | 17 | class PingMessage(object): 18 | ## header start byte 1 19 | start_1 = ord("B") 20 | 21 | ## header start byte 2 22 | start_2 = ord("R") 23 | 24 | ## header struct format 25 | header_format = "BBHHBB" 26 | 27 | ## checksum struct format 28 | checksum_format = "H" 29 | 30 | ## data endianness for struct formatting 31 | endianess = "<" 32 | 33 | ## names of the header fields 34 | header_field_names = ( 35 | "start_1", 36 | "start_2", 37 | "payload_length", 38 | "message_id", 39 | "src_device_id", 40 | "dst_device_id") 41 | 42 | ## number of bytes in a header 43 | headerLength = 8 44 | 45 | ## number of bytes in a checksum 46 | checksumLength = 2 47 | 48 | ## Messge constructor 49 | # 50 | # @par Ex request: 51 | # @code 52 | # m = PingMessage() 53 | # m.request_id = m_id 54 | # m.pack_msg_data() 55 | # write(m.msg_data) 56 | # @endcode 57 | # 58 | # @par Ex set: 59 | # @code 60 | # m = PingMessage(PING1D_SET_RANGE) 61 | # m.start_mm = 1000 62 | # m.length_mm = 2000 63 | # m.update_checksum() 64 | # write(m.msg_data) 65 | # @endcode 66 | # 67 | # @par Ex receive: 68 | # @code 69 | # m = PingMessage(rxByteArray) 70 | # if m.message_id == PING1D_RANGE 71 | # start_mm = m.start_mm 72 | # length_mm = m.length_mm 73 | # @endcode 74 | def __init__(self, msg_id=0, msg_data=None): 75 | ## The message id 76 | self.message_id = msg_id 77 | 78 | ## The request id for request messages 79 | self.request_id = None 80 | 81 | ## The message destination 82 | self.dst_device_id = 0 83 | ## The message source 84 | self.src_device_id = 0 85 | ## The message checksum 86 | self.checksum = 0 87 | 88 | ## The raw data buffer for this message 89 | # update with pack_msg_data() 90 | self.msg_data = None 91 | 92 | # Constructor 1: make a pingmessage object from a binary data buffer 93 | # (for receiving + unpacking) 94 | if msg_data is not None: 95 | if not self.unpack_msg_data(msg_data): 96 | # Attempted to create an unknown message 97 | return 98 | # Constructor 2: make a pingmessage object cooresponding to a message 99 | # id, with field members ready to access and populate 100 | # (for packing + transmitting) 101 | else: 102 | 103 | try: 104 | ## The name of this message 105 | self.name = payload_dict[self.message_id]["name"] 106 | 107 | ## The field names of this message 108 | self.payload_field_names = payload_dict[self.message_id]["field_names"] 109 | 110 | # initialize payload field members 111 | for attr in self.payload_field_names: 112 | setattr(self, attr, 0) 113 | 114 | # initialize vector fields 115 | if self.message_id in variable_msgs: 116 | setattr(self, self.payload_field_names[-1], bytearray()) 117 | 118 | ## Number of bytes in the message payload 119 | self.update_payload_length() 120 | 121 | ## The struct formatting string for the message payload 122 | self.payload_format = self.get_payload_format() 123 | 124 | # TODO handle better here, and catch Constructor 1 also 125 | except KeyError as e: 126 | print("message id not recognized: %d" % self.message_id, msg_data) 127 | raise e 128 | 129 | ## Pack object attributes into self.msg_data (bytearray) 130 | # @return self.msg_data 131 | def pack_msg_data(self): 132 | # necessary for variable length payloads 133 | # update using current contents for the variable length field 134 | self.update_payload_length() 135 | 136 | # Prepare struct packing format string 137 | msg_format = PingMessage.endianess + PingMessage.header_format + self.get_payload_format() 138 | 139 | # Prepare complete list of field names (header + payload) 140 | attrs = PingMessage.header_field_names + payload_dict[self.message_id]["field_names"] 141 | 142 | # Prepare iterable ordered list of values to pack 143 | values = [] 144 | for attr in attrs: 145 | # this is a hack for requests 146 | if attr == "message_id" and self.request_id is not None: 147 | values.append(self.request_id) 148 | else: 149 | values.append(getattr(self, attr)) 150 | 151 | # Pack message contents into bytearray 152 | self.msg_data = bytearray(struct.pack(msg_format, *values)) 153 | 154 | # Update and append checksum 155 | self.msg_data += bytearray(struct.pack(PingMessage.endianess + PingMessage.checksum_format, self.update_checksum())) 156 | 157 | return self.msg_data 158 | 159 | ## Attempts to unpack a bytearray into object attributes 160 | # @Returns True if successful, False otherwise 161 | def unpack_msg_data(self, msg_data): 162 | self.msg_data = msg_data 163 | 164 | # Extract header 165 | header = struct.unpack(PingMessage.endianess + PingMessage.header_format, self.msg_data[0:PingMessage.headerLength]) 166 | 167 | for i, attr in enumerate(PingMessage.header_field_names): 168 | setattr(self, attr, header[i]) 169 | 170 | ## The name of this message 171 | try: 172 | self.name = payload_dict[self.message_id]["name"] 173 | except KeyError: 174 | print("Unknown message: ", self.message_id) 175 | return False 176 | 177 | ## The field names of this message 178 | self.payload_field_names = payload_dict[self.message_id]["field_names"] 179 | 180 | if self.payload_length > 0: 181 | ## The struct formatting string for the message payload 182 | self.payload_format = self.get_payload_format() 183 | 184 | # Extract payload 185 | try: 186 | payload = struct.unpack(PingMessage.endianess + self.payload_format, self.msg_data[PingMessage.headerLength:PingMessage.headerLength + self.payload_length]) 187 | except Exception as e: 188 | print("error unpacking payload: %s" % e) 189 | print("msg_data: %s, header: %s" % (msg_data, header)) 190 | print("format: %s, buf: %s" % (PingMessage.endianess + self.payload_format, self.msg_data[PingMessage.headerLength:PingMessage.headerLength + self.payload_length])) 191 | print(self.payload_format) 192 | else: # only use payload if didn't raise exception 193 | for i, attr in enumerate(self.payload_field_names): 194 | try: 195 | setattr(self, attr, payload[i]) 196 | # empty trailing variable data field 197 | except IndexError as e: 198 | if self.message_id in variable_msgs: 199 | setattr(self, attr, bytearray()) 200 | pass 201 | 202 | # Extract checksum 203 | self.checksum = struct.unpack(PingMessage.endianess + PingMessage.checksum_format, self.msg_data[PingMessage.headerLength + self.payload_length: PingMessage.headerLength + self.payload_length + PingMessage.checksumLength])[0] 204 | return True 205 | 206 | ## Calculate the checksum from the internal bytearray self.msg_data 207 | def calculate_checksum(self): 208 | return sum(self.msg_data[0:PingMessage.headerLength + self.payload_length]) & 0xffff 209 | 210 | ## Update the object checksum value 211 | # @return the object checksum value 212 | def update_checksum(self): 213 | self.checksum = self.calculate_checksum() 214 | return self.checksum 215 | 216 | ## Verify that the object checksum attribute is equal to the checksum calculated according to the internal bytearray self.msg_data 217 | def verify_checksum(self): 218 | return self.checksum == self.calculate_checksum() 219 | 220 | ## Update the payload_length attribute with the **current** payload length, including dynamic length fields (if present) 221 | def update_payload_length(self): 222 | if self.message_id in variable_msgs or self.message_id in asciiMsgs: 223 | # The last field self.payload_field_names[-1] is always the single dynamic-length field 224 | self.payload_length = payload_dict[self.message_id]["payload_length"] + len(getattr(self, self.payload_field_names[-1])) 225 | else: 226 | self.payload_length = payload_dict[self.message_id]["payload_length"] 227 | 228 | ## Get the python struct formatting string for the message payload 229 | # @return the payload struct format string 230 | def get_payload_format(self): 231 | # messages with variable length fields 232 | if self.message_id in variable_msgs or self.message_id in asciiMsgs: 233 | var_length = self.payload_length - payload_dict[self.message_id]["payload_length"] # Subtract static length portion from payload length 234 | if var_length <= 0: 235 | return payload_dict[self.message_id]["format"] # variable data portion is empty 236 | 237 | return payload_dict[self.message_id]["format"] + str(var_length) + "s" 238 | else: # messages with a static (constant) length 239 | return payload_dict[self.message_id]["format"] 240 | 241 | ## Dump object into string representation 242 | # @return string representation of the object 243 | def __repr__(self): 244 | header_string = "Header:" 245 | for attr in PingMessage.header_field_names: 246 | header_string += " " + attr + ": " + str(getattr(self, attr)) 247 | 248 | if self.payload_length == 0: # this is a hack/guard for empty body requests 249 | payload_string = "" 250 | else: 251 | payload_string = "Payload:" 252 | 253 | # handle variable length messages 254 | if self.message_id in variable_msgs: 255 | 256 | # static fields are handled as usual 257 | for attr in payload_dict[self.message_id]["field_names"][:-1]: 258 | payload_string += "\n - " + attr + ": " + str(getattr(self, attr)) 259 | 260 | # the variable length field is always the last field 261 | attr = payload_dict[self.message_id]["field_names"][-1:][0] 262 | 263 | # format this field as a list of hex values (rather than a string if we did not perform this handling) 264 | payload_string += "\n - " + attr + ": " + str([hex(item) for item in getattr(self, attr)]) 265 | 266 | else: # handling of static length messages and text messages 267 | for attr in payload_dict[self.message_id]["field_names"]: 268 | payload_string += "\n - " + attr + ": " + str(getattr(self, attr)) 269 | 270 | representation = ( 271 | "\n\n--------------------------------------------------\n" 272 | "ID: " + str(self.message_id) + " - " + self.name + "\n" + 273 | header_string + "\n" + 274 | payload_string + "\n" + 275 | "Checksum: " + str(self.checksum) + " check: " + str(self.calculate_checksum()) + " pass: " + str(self.verify_checksum()) 276 | ) 277 | 278 | return representation 279 | 280 | 281 | # A class to digest a serial stream and decode PingMessages 282 | class PingParser(object): 283 | # pre-declare instance variables for faster access and reduced memory overhead 284 | __slots__ = ( 285 | "buf", 286 | "state", 287 | "payload_length", 288 | "message_id", 289 | "errors", 290 | "parsed", 291 | "rx_msg", 292 | ) 293 | 294 | NEW_MESSAGE = 0 # Just got a complete checksum-verified message 295 | WAIT_START = 1 # Waiting for the first character of a message 'B' 296 | WAIT_HEADER = 2 # Waiting for the second character in the two-character sequence 'BR' 297 | WAIT_LENGTH_L = 3 # Waiting for the low byte of the payload length field 298 | WAIT_LENGTH_H = 4 # Waiting for the high byte of the payload length field 299 | WAIT_MSG_ID_L = 5 # Waiting for the low byte of the payload id field 300 | WAIT_MSG_ID_H = 6 # Waiting for the high byte of the payload id field 301 | WAIT_SRC_ID = 7 # Waiting for the source device id 302 | WAIT_DST_ID = 8 # Waiting for the destination device id 303 | WAIT_PAYLOAD = 9 # Waiting for the last byte of the payload to come in 304 | WAIT_CHECKSUM_L = 10 # Waiting for the checksum low byte 305 | WAIT_CHECKSUM_H = 11 # Waiting for the checksum high byte 306 | ERROR = 12 # Checksum didn't check out 307 | 308 | def __init__(self): 309 | self.buf = bytearray() 310 | self.state = self.WAIT_START 311 | self.payload_length = 0 # remaining for the message currently being parsed 312 | self.message_id = 0 # of the message currently being parsed 313 | self.errors = 0 314 | self.parsed = 0 315 | self.rx_msg = None # most recently parsed message 316 | 317 | def wait_start(self, msg_byte): 318 | self.buf = bytearray() 319 | if msg_byte == ord('B'): 320 | self.buf.append(msg_byte) 321 | self.state += 1 322 | 323 | def wait_header(self, msg_byte): 324 | if msg_byte == ord('R'): 325 | self.buf.append(msg_byte) 326 | self.state += 1 327 | else: 328 | self.state = self.WAIT_START 329 | 330 | def wait_length_l(self, msg_byte): 331 | self.payload_length = msg_byte 332 | self.buf.append(msg_byte) 333 | self.state += 1 334 | 335 | def wait_length_h(self, msg_byte): 336 | self.payload_length |= (msg_byte << 8) 337 | self.buf.append(msg_byte) 338 | self.state += 1 339 | 340 | def wait_msg_id_l(self, msg_byte): 341 | self.message_id = msg_byte 342 | self.buf.append(msg_byte) 343 | self.state += 1 344 | 345 | def wait_msg_id_h(self, msg_byte): 346 | self.message_id |= (msg_byte << 8) 347 | self.buf.append(msg_byte) 348 | self.state += 1 349 | 350 | def wait_src_id(self, msg_byte): 351 | self.buf.append(msg_byte) 352 | self.state += 1 353 | 354 | def wait_dst_id(self, msg_byte): 355 | self.buf.append(msg_byte) 356 | self.state += 1 357 | if self.payload_length == 0: # no payload bytes -> skip waiting 358 | self.state += 1 359 | 360 | def wait_payload(self, msg_byte): 361 | self.buf.append(msg_byte) 362 | self.payload_length -= 1 363 | if self.payload_length == 0: # no payload bytes remaining -> stop waiting: 364 | self.state += 1 365 | 366 | def wait_checksum_l(self, msg_byte): 367 | self.buf.append(msg_byte) 368 | self.state += 1 369 | 370 | def wait_checksum_h(self, msg_byte): 371 | self.state = self.WAIT_START 372 | self.payload_length = 0 373 | self.message_id = 0 374 | 375 | self.buf.append(msg_byte) 376 | self.rx_msg = PingMessage(msg_data=self.buf) 377 | 378 | if self.rx_msg.verify_checksum(): 379 | self.parsed += 1 380 | return self.NEW_MESSAGE 381 | else: 382 | self.errors += 1 383 | return self.ERROR 384 | 385 | return self.state 386 | 387 | def parse_byte(self, msg_byte): 388 | """ Returns the current parse state after feeding the parser a single byte. 389 | 390 | 'msg_byte' is the byte to parse. 391 | If it completes a valid message, returns PingParser.NEW_MESSAGE. 392 | The decoded PingMessage will be available in the self.rx_msg attribute 393 | until a new message is decoded. 394 | """ 395 | # Apply the relevant parsing method for the current state. 396 | # (offset by 1 because NEW_MESSAGE isn't processed - start at WAIT_START) 397 | result = self._PARSE_BYTE[self.state - 1](self, msg_byte) 398 | 399 | return self.state if result is None else result 400 | 401 | # Tuple of parsing methods, in order of parser state 402 | # at bottom because otherwise methods won't be defined 403 | _PARSE_BYTE = ( 404 | wait_start, 405 | wait_header, 406 | wait_length_l, 407 | wait_length_h, 408 | wait_msg_id_l, 409 | wait_msg_id_h, 410 | wait_src_id, 411 | wait_dst_id, 412 | wait_payload, 413 | wait_checksum_l, 414 | wait_checksum_h, 415 | ) 416 | 417 | 418 | if __name__ == "__main__": 419 | # Hand-written data buffers for testing and verification 420 | test_protocol_version_buf = bytearray([ 421 | 0x42, 422 | 0x52, 423 | 4, 424 | 0, 425 | definitions.COMMON_PROTOCOL_VERSION, 426 | 0, 427 | 77, 428 | 211, 429 | 1, 430 | 2, 431 | 3, 432 | 99, 433 | 0x26, 434 | 0x02]) 435 | 436 | test_profile_buf = bytearray([ 437 | 0x42, # 'B' 438 | 0x52, # 'R' 439 | 0x24, # 36_L payload length 440 | 0x00, # 36_H 441 | 0x14, # 1300_L message id 442 | 0x05, # 1300_H 443 | 56, 444 | 45, 445 | 0xe8, # 1000_L distance 446 | 0x03, # 1000_H 447 | 0x00, # 1000_H 448 | 0x00, # 1000_H 449 | 93, # 93_L confidence 450 | 0x00, # 93_H 451 | 0x3f, # 2111_L transmit duration 452 | 0x08, # 2111_H 453 | 0x1c, # 44444444_L ping number 454 | 0x2b, # 44444444_H 455 | 0xa6, # 44444444_H 456 | 0x02, # 44444444_H 457 | 0xa0, # 4000_L scan start 458 | 0x0f, # 4000_H 459 | 0x00, # 4000_H 460 | 0x00, # 4000_H 461 | 0xb8, # 35000_L scan length 462 | 0x88, # 35000_H 463 | 0x00, # 35000_H 464 | 0x00, # 35000_H 465 | 0x04, # 4_L gain setting 466 | 0x00, # 4_H 467 | 0x00, # 4_H 468 | 0x00, # 4_H 469 | 10, # 10_L profile data length 470 | 0x00, # 10_H 471 | 0,1,2,3,4,5,6,7,8,9, # profile data 472 | 0xde, # 1502_H checksum 473 | 0x05 # 1502_L 474 | ]) 475 | 476 | p = PingParser() 477 | 478 | result = None 479 | # A text message 480 | print("\n---Testing protocol_version---\n") 481 | for byte in test_protocol_version_buf: 482 | result = p.parse_byte(byte) 483 | 484 | if result == p.NEW_MESSAGE: 485 | print(p.rx_msg) 486 | else: 487 | print("fail:", result) 488 | exit(1) 489 | 490 | # A dynamic vector message 491 | print("\n---Testing profile---\n") 492 | for byte in test_profile_buf: 493 | result = p.parse_byte(byte) 494 | 495 | if result == p.NEW_MESSAGE: 496 | print(p.rx_msg) 497 | else: 498 | print("fail:", result) 499 | exit(1) 500 | -------------------------------------------------------------------------------- /ci/ci-functions.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # print control for echob() 4 | bold=$(tput bold) 5 | normal=$(tput sgr0) 6 | 7 | # counter for travis_fold: https://github.com/travis-ci/travis-ci/issues/2285 8 | if [ -z $testN ]; then testN=0; fi 9 | 10 | # echo with bold text 11 | echob() { 12 | echo "${bold}${@}${normal}" 13 | } 14 | 15 | # run command helper for ci scripts 16 | test() { 17 | echo -en "travis_fold:start:$testN\r \r" 18 | echob "$@" 19 | "$@" 20 | exitcode=$? 21 | echo -en "travis_fold:end:$testN\r \r" 22 | echob "$@ exited with $exitcode" 23 | if [ $exitcode -ne 0 ]; then exit $exitcode; fi 24 | testN=$(($testN+1)) 25 | } 26 | -------------------------------------------------------------------------------- /ci/deploy-gh-pages.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # Deploy repository documentation 4 | 5 | source ci/ci-functions.sh 6 | 7 | doc_path="doc" 8 | 9 | echob "generating message api..." 10 | test pip install jinja2 11 | test generate/generate-python.py --output-dir=brping 12 | 13 | echob "Build doxygen documentation." 14 | test cd $doc_path 15 | test doxygen Doxyfile 16 | 17 | echo "- Check files" 18 | ls -A "html/" 19 | -------------------------------------------------------------------------------- /ci/deploy-whitelist: -------------------------------------------------------------------------------- 1 | brping/__init__.py 2 | brping/definitions.py 3 | brping/device.py 4 | brping/ping1d.py 5 | brping/ping360.py 6 | brping/pingmessage.py 7 | examples 8 | tools 9 | LICENSE 10 | setup.py 11 | -------------------------------------------------------------------------------- /ci/deploy.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # source helper functions 4 | source ci/ci-functions.sh 5 | 6 | # TODO make test() work with | pipe 7 | cat ci/deploy-whitelist | xargs git add -f 8 | # commit generated files if necessary, it's ok if commit fails 9 | git commit -m "temporary commit" 10 | # move to deployment branch 11 | test git checkout deployment 12 | test rm -rf * 13 | # get the list of files that should be version controlled in deployment branch 14 | test git checkout HEAD@{1} ci/deploy-whitelist 15 | # add those files 16 | cat ci/deploy-whitelist | xargs git checkout HEAD@{1} 17 | test git --no-pager diff --staged 18 | # unstage the whitelist 19 | test git rm -f ci/deploy-whitelist 20 | -------------------------------------------------------------------------------- /ci/travis-ci-script.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | source ci/ci-functions.sh 4 | 5 | echob "generating message api..." 6 | test pip install jinja2 7 | test generate/generate-python.py --output-dir=brping 8 | 9 | echob "installing package..." 10 | test python setup.py install 11 | 12 | echob "testing message api..." 13 | test python brping/pingmessage.py 14 | 15 | echob "update gh pages..." 16 | test pip install pyOpenSSL 17 | test ci/deploy-gh-pages.sh 18 | 19 | echob "deploying..." 20 | test ci/deploy.sh 21 | -------------------------------------------------------------------------------- /doc/.gitignore: -------------------------------------------------------------------------------- 1 | latex 2 | html 3 | -------------------------------------------------------------------------------- /doc/Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.14 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 config file 21 | # that follow. The default is UTF-8 which is also the encoding used for all text 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 | # 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 = ping-python 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 = "A python implementation of the Blue Robotics Ping messaging protocol and a device API for the Blue Robotics Ping1D echosounder." 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 = ./ping.png 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 = xml 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 = NO 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 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97 | # descriptions after the members that are listed in the file and class 98 | # documentation (similar to Javadoc). Set to NO to disable this. 99 | # The default value is: YES. 100 | 101 | BRIEF_MEMBER_DESC = YES 102 | 103 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104 | # description of a member or function before the detailed description 105 | # 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 | # brief descriptions will be completely suppressed. 108 | # The default value is: YES. 109 | 110 | REPEAT_BRIEF = YES 111 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is 113 | # used to form the text in various listings. Each string in this list, if found 114 | # as the leading text of the brief description, will be stripped from the text 115 | # and the result, after processing the whole list, is used as the annotated 116 | # text. Otherwise, the brief description is used as-is. If left blank, the 117 | # following values are used ($name is automatically replaced with the name of 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, 119 | # specifies, contains, represents, a, an and the. 120 | 121 | ABBREVIATE_BRIEF = 122 | 123 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 124 | # doxygen will generate a detailed section even if there is only a brief 125 | # description. 126 | # The default value is: NO. 127 | 128 | ALWAYS_DETAILED_SEC = NO 129 | 130 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 131 | # inherited members of a class in the documentation of that class as if those 132 | # members were ordinary class members. Constructors, destructors and assignment 133 | # operators of the base classes will not be shown. 134 | # The default value is: NO. 135 | 136 | INLINE_INHERITED_MEMB = NO 137 | 138 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 139 | # before files name in the file list and in the header files. If set to NO the 140 | # shortest path that makes the file name unique will be used 141 | # The default value is: YES. 142 | 143 | FULL_PATH_NAMES = YES 144 | 145 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 146 | # Stripping is only done if one of the specified strings matches the left-hand 147 | # part of the path. The tag can be used to show relative paths in the file list. 148 | # If left blank the directory from which doxygen is run is used as the path to 149 | # strip. 150 | # 151 | # Note that you can specify absolute paths here, but also relative paths, which 152 | # will be relative from the directory where doxygen is started. 153 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 154 | 155 | STRIP_FROM_PATH = 156 | 157 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 158 | # path mentioned in the documentation of a class, which tells the reader which 159 | # header file to include in order to use a class. If left blank only the name of 160 | # the header file containing the class definition is used. Otherwise one should 161 | # specify the list of include paths that are normally passed to the compiler 162 | # using the -I flag. 163 | 164 | STRIP_FROM_INC_PATH = 165 | 166 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 167 | # less readable) file names. This can be useful is your file systems doesn't 168 | # support long names like on DOS, Mac, or CD-ROM. 169 | # The default value is: NO. 170 | 171 | SHORT_NAMES = NO 172 | 173 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 174 | # first line (until the first dot) of a Javadoc-style comment as the brief 175 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 176 | # style comments (thus requiring an explicit @brief command for a brief 177 | # description.) 178 | # The default value is: NO. 179 | 180 | JAVADOC_AUTOBRIEF = NO 181 | 182 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 183 | # line (until the first dot) of a Qt-style comment as the brief description. If 184 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 185 | # requiring an explicit \brief command for a brief description.) 186 | # The default value is: NO. 187 | 188 | QT_AUTOBRIEF = NO 189 | 190 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 191 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 192 | # a brief description. This used to be the default behavior. The new default is 193 | # to treat a multi-line C++ comment block as a detailed description. Set this 194 | # tag to YES if you prefer the old behavior instead. 195 | # 196 | # Note that setting this tag to YES also means that rational rose comments are 197 | # not recognized any more. 198 | # The default value is: NO. 199 | 200 | MULTILINE_CPP_IS_BRIEF = NO 201 | 202 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 203 | # documentation from any documented member that it re-implements. 204 | # The default value is: YES. 205 | 206 | INHERIT_DOCS = YES 207 | 208 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 209 | # page for each member. If set to NO, the documentation of a member will be part 210 | # of the file/class/namespace that contains it. 211 | # The default value is: NO. 212 | 213 | SEPARATE_MEMBER_PAGES = NO 214 | 215 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 216 | # uses this value to replace tabs by spaces in code fragments. 217 | # Minimum value: 1, maximum value: 16, default value: 4. 218 | 219 | TAB_SIZE = 4 220 | 221 | # This tag can be used to specify a number of aliases that act as commands in 222 | # the documentation. An alias has the form: 223 | # name=value 224 | # For example adding 225 | # "sideeffect=@par Side Effects:\n" 226 | # will allow you to put the command \sideeffect (or @sideeffect) in the 227 | # documentation, which will result in a user-defined paragraph with heading 228 | # "Side Effects:". You can put \n's in the value part of an alias to insert 229 | # newlines (in the resulting output). You can put ^^ in the value part of an 230 | # alias to insert a newline as if a physical newline was in the original file. 231 | 232 | ALIASES = 233 | 234 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 235 | # A mapping has the form "name=value". For example adding "class=itcl::class" 236 | # will allow you to use the command class in the itcl::class meaning. 237 | 238 | TCL_SUBST = 239 | 240 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 241 | # only. Doxygen will then generate output that is more tailored for C. For 242 | # instance, some of the names that are used will be different. The list of all 243 | # members will be omitted, etc. 244 | # The default value is: NO. 245 | 246 | OPTIMIZE_OUTPUT_FOR_C = NO 247 | 248 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 249 | # Python sources only. Doxygen will then generate output that is more tailored 250 | # for that language. For instance, namespaces will be presented as packages, 251 | # qualified scopes will look different, etc. 252 | # The default value is: NO. 253 | 254 | OPTIMIZE_OUTPUT_JAVA = NO 255 | 256 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 257 | # sources. Doxygen will then generate output that is tailored for Fortran. 258 | # The default value is: NO. 259 | 260 | OPTIMIZE_FOR_FORTRAN = NO 261 | 262 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 263 | # sources. Doxygen will then generate output that is tailored for VHDL. 264 | # The default value is: NO. 265 | 266 | OPTIMIZE_OUTPUT_VHDL = NO 267 | 268 | # Doxygen selects the parser to use depending on the extension of the files it 269 | # parses. With this tag you can assign which parser to use for a given 270 | # extension. Doxygen has a built-in mapping, but you can override or extend it 271 | # using this tag. The format is ext=language, where ext is a file extension, and 272 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 273 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 274 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 275 | # Fortran. In the later case the parser tries to guess whether the code is fixed 276 | # or free formatted code, this is the default for Fortran type files), VHDL. For 277 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 278 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 279 | # 280 | # Note: For files without extension you can use no_extension as a placeholder. 281 | # 282 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 283 | # the files are not read by doxygen. 284 | 285 | EXTENSION_MAPPING = 286 | 287 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 288 | # according to the Markdown format, which allows for more readable 289 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 290 | # The output of markdown processing is further processed by doxygen, so you can 291 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 292 | # case of backward compatibilities issues. 293 | # The default value is: YES. 294 | 295 | MARKDOWN_SUPPORT = YES 296 | 297 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 298 | # to that level are automatically included in the table of contents, even if 299 | # they do not have an id attribute. 300 | # Note: This feature currently applies only to Markdown headings. 301 | # Minimum value: 0, maximum value: 99, default value: 0. 302 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 303 | 304 | TOC_INCLUDE_HEADINGS = 0 305 | 306 | # When enabled doxygen tries to link words that correspond to documented 307 | # classes, or namespaces to their corresponding documentation. Such a link can 308 | # be prevented in individual cases by putting a % sign in front of the word or 309 | # globally by setting AUTOLINK_SUPPORT to NO. 310 | # The default value is: YES. 311 | 312 | AUTOLINK_SUPPORT = YES 313 | 314 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 315 | # to include (a tag file for) the STL sources as input, then you should set this 316 | # tag to YES in order to let doxygen match functions declarations and 317 | # definitions whose arguments contain STL classes (e.g. func(std::string); 318 | # versus func(std::string) {}). This also make the inheritance and collaboration 319 | # diagrams that involve STL classes more complete and accurate. 320 | # The default value is: NO. 321 | 322 | BUILTIN_STL_SUPPORT = NO 323 | 324 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 325 | # enable parsing support. 326 | # The default value is: NO. 327 | 328 | CPP_CLI_SUPPORT = NO 329 | 330 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 331 | # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 332 | # will parse them like normal C++ but will assume all classes use public instead 333 | # of private inheritance when no explicit protection keyword is present. 334 | # The default value is: NO. 335 | 336 | SIP_SUPPORT = NO 337 | 338 | # For Microsoft's IDL there are propget and propput attributes to indicate 339 | # getter and setter methods for a property. Setting this option to YES will make 340 | # doxygen to replace the get and set methods by a property in the documentation. 341 | # This will only work if the methods are indeed getting or setting a simple 342 | # type. If this is not the case, or you want to show the methods anyway, you 343 | # should set this option to NO. 344 | # The default value is: YES. 345 | 346 | IDL_PROPERTY_SUPPORT = YES 347 | 348 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 349 | # tag is set to YES then doxygen will reuse the documentation of the first 350 | # member in the group (if any) for the other members of the group. By default 351 | # all members of a group must be documented explicitly. 352 | # The default value is: NO. 353 | 354 | DISTRIBUTE_GROUP_DOC = NO 355 | 356 | # If one adds a struct or class to a group and this option is enabled, then also 357 | # any nested class or struct is added to the same group. By default this option 358 | # is disabled and one has to add nested compounds explicitly via \ingroup. 359 | # The default value is: NO. 360 | 361 | GROUP_NESTED_COMPOUNDS = NO 362 | 363 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 364 | # (for instance a group of public functions) to be put as a subgroup of that 365 | # type (e.g. under the Public Functions section). Set it to NO to prevent 366 | # subgrouping. Alternatively, this can be done per class using the 367 | # \nosubgrouping command. 368 | # The default value is: YES. 369 | 370 | SUBGROUPING = YES 371 | 372 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 373 | # are shown inside the group in which they are included (e.g. using \ingroup) 374 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 375 | # and RTF). 376 | # 377 | # Note that this feature does not work in combination with 378 | # SEPARATE_MEMBER_PAGES. 379 | # The default value is: NO. 380 | 381 | INLINE_GROUPED_CLASSES = NO 382 | 383 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 384 | # with only public data fields or simple typedef fields will be shown inline in 385 | # the documentation of the scope in which they are defined (i.e. file, 386 | # namespace, or group documentation), provided this scope is documented. If set 387 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 388 | # Man pages) or section (for LaTeX and RTF). 389 | # The default value is: NO. 390 | 391 | INLINE_SIMPLE_STRUCTS = NO 392 | 393 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 394 | # enum is documented as struct, union, or enum with the name of the typedef. So 395 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 396 | # with name TypeT. When disabled the typedef will appear as a member of a file, 397 | # namespace, or class. And the struct will be named TypeS. This can typically be 398 | # useful for C code in case the coding convention dictates that all compound 399 | # types are typedef'ed and only the typedef is referenced, never the tag name. 400 | # The default value is: NO. 401 | 402 | TYPEDEF_HIDES_STRUCT = NO 403 | 404 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 405 | # cache is used to resolve symbols given their name and scope. Since this can be 406 | # an expensive process and often the same symbol appears multiple times in the 407 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 408 | # doxygen will become slower. If the cache is too large, memory is wasted. The 409 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 410 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 411 | # symbols. At the end of a run doxygen will report the cache usage and suggest 412 | # the optimal cache size from a speed point of view. 413 | # Minimum value: 0, maximum value: 9, default value: 0. 414 | 415 | LOOKUP_CACHE_SIZE = 0 416 | 417 | #--------------------------------------------------------------------------- 418 | # Build related configuration options 419 | #--------------------------------------------------------------------------- 420 | 421 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 422 | # documentation are documented, even if no documentation was available. Private 423 | # class members and static file members will be hidden unless the 424 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 425 | # Note: This will also disable the warnings about undocumented members that are 426 | # normally produced when WARNINGS is set to YES. 427 | # The default value is: NO. 428 | 429 | EXTRACT_ALL = NO 430 | 431 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 432 | # be included in the documentation. 433 | # The default value is: NO. 434 | 435 | EXTRACT_PRIVATE = NO 436 | 437 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 438 | # scope will be included in the documentation. 439 | # The default value is: NO. 440 | 441 | EXTRACT_PACKAGE = NO 442 | 443 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 444 | # included in the documentation. 445 | # The default value is: NO. 446 | 447 | EXTRACT_STATIC = NO 448 | 449 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 450 | # locally in source files will be included in the documentation. If set to NO, 451 | # only classes defined in header files are included. Does not have any effect 452 | # for Java sources. 453 | # The default value is: YES. 454 | 455 | EXTRACT_LOCAL_CLASSES = YES 456 | 457 | # This flag is only useful for Objective-C code. If set to YES, local methods, 458 | # which are defined in the implementation section but not in the interface are 459 | # included in the documentation. If set to NO, only methods in the interface are 460 | # included. 461 | # The default value is: NO. 462 | 463 | EXTRACT_LOCAL_METHODS = NO 464 | 465 | # If this flag is set to YES, the members of anonymous namespaces will be 466 | # extracted and appear in the documentation as a namespace called 467 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 468 | # the file that contains the anonymous namespace. By default anonymous namespace 469 | # are hidden. 470 | # The default value is: NO. 471 | 472 | EXTRACT_ANON_NSPACES = NO 473 | 474 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 475 | # undocumented members inside documented classes or files. If set to NO these 476 | # members will be included in the various overviews, but no documentation 477 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 478 | # The default value is: NO. 479 | 480 | HIDE_UNDOC_MEMBERS = NO 481 | 482 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 483 | # undocumented classes that are normally visible in the class hierarchy. If set 484 | # to NO, these classes will be included in the various overviews. This option 485 | # has no effect if EXTRACT_ALL is enabled. 486 | # The default value is: NO. 487 | 488 | HIDE_UNDOC_CLASSES = NO 489 | 490 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 491 | # (class|struct|union) declarations. If set to NO, these declarations will be 492 | # included in the documentation. 493 | # The default value is: NO. 494 | 495 | HIDE_FRIEND_COMPOUNDS = NO 496 | 497 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 498 | # documentation blocks found inside the body of a function. If set to NO, these 499 | # blocks will be appended to the function's detailed documentation block. 500 | # The default value is: NO. 501 | 502 | HIDE_IN_BODY_DOCS = NO 503 | 504 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 505 | # \internal command is included. If the tag is set to NO then the documentation 506 | # will be excluded. Set it to YES to include the internal documentation. 507 | # The default value is: NO. 508 | 509 | INTERNAL_DOCS = NO 510 | 511 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 512 | # names in lower-case letters. If set to YES, upper-case letters are also 513 | # allowed. This is useful if you have classes or files whose names only differ 514 | # in case and if your file system supports case sensitive file names. Windows 515 | # and Mac users are advised to set this option to NO. 516 | # The default value is: system dependent. 517 | 518 | CASE_SENSE_NAMES = YES 519 | 520 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 521 | # their full class and namespace scopes in the documentation. If set to YES, the 522 | # scope will be hidden. 523 | # The default value is: NO. 524 | 525 | HIDE_SCOPE_NAMES = NO 526 | 527 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 528 | # append additional text to a page's title, such as Class Reference. If set to 529 | # YES the compound reference will be hidden. 530 | # The default value is: NO. 531 | 532 | HIDE_COMPOUND_REFERENCE= NO 533 | 534 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 535 | # the files that are included by a file in the documentation of that file. 536 | # The default value is: YES. 537 | 538 | SHOW_INCLUDE_FILES = YES 539 | 540 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 541 | # grouped member an include statement to the documentation, telling the reader 542 | # which file to include in order to use the member. 543 | # The default value is: NO. 544 | 545 | SHOW_GROUPED_MEMB_INC = NO 546 | 547 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 548 | # files with double quotes in the documentation rather than with sharp brackets. 549 | # The default value is: NO. 550 | 551 | FORCE_LOCAL_INCLUDES = NO 552 | 553 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 554 | # documentation for inline members. 555 | # The default value is: YES. 556 | 557 | INLINE_INFO = YES 558 | 559 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 560 | # (detailed) documentation of file and class members alphabetically by member 561 | # name. If set to NO, the members will appear in declaration order. 562 | # The default value is: YES. 563 | 564 | SORT_MEMBER_DOCS = YES 565 | 566 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 567 | # descriptions of file, namespace and class members alphabetically by member 568 | # name. If set to NO, the members will appear in declaration order. Note that 569 | # this will also influence the order of the classes in the class list. 570 | # The default value is: NO. 571 | 572 | SORT_BRIEF_DOCS = NO 573 | 574 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 575 | # (brief and detailed) documentation of class members so that constructors and 576 | # destructors are listed first. If set to NO the constructors will appear in the 577 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 578 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 579 | # member documentation. 580 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 581 | # detailed member documentation. 582 | # The default value is: NO. 583 | 584 | SORT_MEMBERS_CTORS_1ST = NO 585 | 586 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 587 | # of group names into alphabetical order. If set to NO the group names will 588 | # appear in their defined order. 589 | # The default value is: NO. 590 | 591 | SORT_GROUP_NAMES = NO 592 | 593 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 594 | # fully-qualified names, including namespaces. If set to NO, the class list will 595 | # be sorted only by class name, not including the namespace part. 596 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 597 | # Note: This option applies only to the class list, not to the alphabetical 598 | # list. 599 | # The default value is: NO. 600 | 601 | SORT_BY_SCOPE_NAME = NO 602 | 603 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 604 | # type resolution of all parameters of a function it will reject a match between 605 | # the prototype and the implementation of a member function even if there is 606 | # only one candidate or it is obvious which candidate to choose by doing a 607 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 608 | # accept a match between prototype and implementation in such cases. 609 | # The default value is: NO. 610 | 611 | STRICT_PROTO_MATCHING = NO 612 | 613 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 614 | # list. This list is created by putting \todo commands in the documentation. 615 | # The default value is: YES. 616 | 617 | GENERATE_TODOLIST = YES 618 | 619 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 620 | # list. This list is created by putting \test commands in the documentation. 621 | # The default value is: YES. 622 | 623 | GENERATE_TESTLIST = YES 624 | 625 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 626 | # list. This list is created by putting \bug commands in the documentation. 627 | # The default value is: YES. 628 | 629 | GENERATE_BUGLIST = YES 630 | 631 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 632 | # the deprecated list. This list is created by putting \deprecated commands in 633 | # the documentation. 634 | # The default value is: YES. 635 | 636 | GENERATE_DEPRECATEDLIST= YES 637 | 638 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 639 | # sections, marked by \if ... \endif and \cond 640 | # ... \endcond blocks. 641 | 642 | ENABLED_SECTIONS = 643 | 644 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 645 | # initial value of a variable or macro / define can have for it to appear in the 646 | # documentation. If the initializer consists of more lines than specified here 647 | # it will be hidden. Use a value of 0 to hide initializers completely. The 648 | # appearance of the value of individual variables and macros / defines can be 649 | # controlled using \showinitializer or \hideinitializer command in the 650 | # documentation regardless of this setting. 651 | # Minimum value: 0, maximum value: 10000, default value: 30. 652 | 653 | MAX_INITIALIZER_LINES = 30 654 | 655 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 656 | # the bottom of the documentation of classes and structs. If set to YES, the 657 | # list will mention the files that were used to generate the documentation. 658 | # The default value is: YES. 659 | 660 | SHOW_USED_FILES = YES 661 | 662 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 663 | # will remove the Files entry from the Quick Index and from the Folder Tree View 664 | # (if specified). 665 | # The default value is: YES. 666 | 667 | SHOW_FILES = YES 668 | 669 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 670 | # page. This will remove the Namespaces entry from the Quick Index and from the 671 | # Folder Tree View (if specified). 672 | # The default value is: YES. 673 | 674 | SHOW_NAMESPACES = YES 675 | 676 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 677 | # doxygen should invoke to get the current version for each file (typically from 678 | # the version control system). Doxygen will invoke the program by executing (via 679 | # popen()) the command command input-file, where command is the value of the 680 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 681 | # by doxygen. Whatever the program writes to standard output is used as the file 682 | # version. For an example see the documentation. 683 | 684 | FILE_VERSION_FILTER = 685 | 686 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 687 | # by doxygen. The layout file controls the global structure of the generated 688 | # output files in an output format independent way. To create the layout file 689 | # that represents doxygen's defaults, run doxygen with the -l option. You can 690 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 691 | # will be used as the name of the layout file. 692 | # 693 | # Note that if you run doxygen from a directory containing a file called 694 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 695 | # tag is left empty. 696 | 697 | LAYOUT_FILE = 698 | 699 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 700 | # the reference definitions. This must be a list of .bib files. The .bib 701 | # extension is automatically appended if omitted. This requires the bibtex tool 702 | # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 703 | # For LaTeX the style of the bibliography can be controlled using 704 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 705 | # search path. See also \cite for info how to create references. 706 | 707 | CITE_BIB_FILES = 708 | 709 | #--------------------------------------------------------------------------- 710 | # Configuration options related to warning and progress messages 711 | #--------------------------------------------------------------------------- 712 | 713 | # The QUIET tag can be used to turn on/off the messages that are generated to 714 | # standard output by doxygen. If QUIET is set to YES this implies that the 715 | # messages are off. 716 | # The default value is: NO. 717 | 718 | QUIET = NO 719 | 720 | # The WARNINGS tag can be used to turn on/off the warning messages that are 721 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 722 | # this implies that the warnings are on. 723 | # 724 | # Tip: Turn warnings on while writing the documentation. 725 | # The default value is: YES. 726 | 727 | WARNINGS = YES 728 | 729 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 730 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 731 | # will automatically be disabled. 732 | # The default value is: YES. 733 | 734 | WARN_IF_UNDOCUMENTED = YES 735 | 736 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 737 | # potential errors in the documentation, such as not documenting some parameters 738 | # in a documented function, or documenting parameters that don't exist or using 739 | # markup commands wrongly. 740 | # The default value is: YES. 741 | 742 | WARN_IF_DOC_ERROR = YES 743 | 744 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 745 | # are documented, but have no documentation for their parameters or return 746 | # value. If set to NO, doxygen will only warn about wrong or incomplete 747 | # parameter documentation, but not about the absence of documentation. 748 | # The default value is: NO. 749 | 750 | WARN_NO_PARAMDOC = NO 751 | 752 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 753 | # a warning is encountered. 754 | # The default value is: NO. 755 | 756 | WARN_AS_ERROR = NO 757 | 758 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 759 | # can produce. The string should contain the $file, $line, and $text tags, which 760 | # will be replaced by the file and line number from which the warning originated 761 | # and the warning text. Optionally the format may contain $version, which will 762 | # be replaced by the version of the file (if it could be obtained via 763 | # FILE_VERSION_FILTER) 764 | # The default value is: $file:$line: $text. 765 | 766 | WARN_FORMAT = "$file:$line: $text" 767 | 768 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 769 | # messages should be written. If left blank the output is written to standard 770 | # error (stderr). 771 | 772 | WARN_LOGFILE = 773 | 774 | #--------------------------------------------------------------------------- 775 | # Configuration options related to the input files 776 | #--------------------------------------------------------------------------- 777 | 778 | # The INPUT tag is used to specify the files and/or directories that contain 779 | # documented source files. You may enter file names like myfile.cpp or 780 | # directories like /usr/src/myproject. Separate the files or directories with 781 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 782 | # Note: If this tag is empty the current directory is searched. 783 | 784 | INPUT = ../brping 785 | 786 | # This tag can be used to specify the character encoding of the source files 787 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 788 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 789 | # documentation (see: https://www.gnu.org/software/libiconv/) for the list of 790 | # possible encodings. 791 | # The default value is: UTF-8. 792 | 793 | INPUT_ENCODING = UTF-8 794 | 795 | # If the value of the INPUT tag contains directories, you can use the 796 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 797 | # *.h) to filter out the source-files in the directories. 798 | # 799 | # Note that for custom extensions or not directly supported extensions you also 800 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 801 | # read by doxygen. 802 | # 803 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 804 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 805 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 806 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 807 | # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. 808 | 809 | FILE_PATTERNS = 810 | 811 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 812 | # be searched for input files as well. 813 | # The default value is: NO. 814 | 815 | RECURSIVE = YES 816 | 817 | # The EXCLUDE tag can be used to specify files and/or directories that should be 818 | # excluded from the INPUT source files. This way you can easily exclude a 819 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 820 | # 821 | # Note that relative paths are relative to the directory from which doxygen is 822 | # run. 823 | 824 | EXCLUDE = 825 | 826 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 827 | # directories that are symbolic links (a Unix file system feature) are excluded 828 | # from the input. 829 | # The default value is: NO. 830 | 831 | EXCLUDE_SYMLINKS = NO 832 | 833 | # If the value of the INPUT tag contains directories, you can use the 834 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 835 | # certain files from those directories. 836 | # 837 | # Note that the wildcards are matched against the file with absolute path, so to 838 | # exclude all test directories for example use the pattern */test/* 839 | 840 | EXCLUDE_PATTERNS = 841 | 842 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 843 | # (namespaces, classes, functions, etc.) that should be excluded from the 844 | # output. The symbol name can be a fully qualified name, a word, or if the 845 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 846 | # AClass::ANamespace, ANamespace::*Test 847 | # 848 | # Note that the wildcards are matched against the file with absolute path, so to 849 | # exclude all test directories use the pattern */test/* 850 | 851 | EXCLUDE_SYMBOLS = 852 | 853 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 854 | # that contain example code fragments that are included (see the \include 855 | # command). 856 | 857 | EXAMPLE_PATH = 858 | 859 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 860 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 861 | # *.h) to filter out the source-files in the directories. If left blank all 862 | # files are included. 863 | 864 | EXAMPLE_PATTERNS = 865 | 866 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 867 | # searched for input files to be used with the \include or \dontinclude commands 868 | # irrespective of the value of the RECURSIVE tag. 869 | # The default value is: NO. 870 | 871 | EXAMPLE_RECURSIVE = NO 872 | 873 | # The IMAGE_PATH tag can be used to specify one or more files or directories 874 | # that contain images that are to be included in the documentation (see the 875 | # \image command). 876 | 877 | IMAGE_PATH = 878 | 879 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 880 | # invoke to filter for each input file. Doxygen will invoke the filter program 881 | # by executing (via popen()) the command: 882 | # 883 | # 884 | # 885 | # where is the value of the INPUT_FILTER tag, and is the 886 | # name of an input file. Doxygen will then use the output that the filter 887 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 888 | # will be ignored. 889 | # 890 | # Note that the filter must not add or remove lines; it is applied before the 891 | # code is scanned, but not when the output code is generated. If lines are added 892 | # or removed, the anchors will not be placed correctly. 893 | # 894 | # Note that for custom extensions or not directly supported extensions you also 895 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 896 | # properly processed by doxygen. 897 | 898 | INPUT_FILTER = 899 | 900 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 901 | # basis. Doxygen will compare the file name with each pattern and apply the 902 | # filter if there is a match. The filters are a list of the form: pattern=filter 903 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 904 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 905 | # patterns match the file name, INPUT_FILTER is applied. 906 | # 907 | # Note that for custom extensions or not directly supported extensions you also 908 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 909 | # properly processed by doxygen. 910 | 911 | FILTER_PATTERNS = 912 | 913 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 914 | # INPUT_FILTER) will also be used to filter the input files that are used for 915 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 916 | # The default value is: NO. 917 | 918 | FILTER_SOURCE_FILES = NO 919 | 920 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 921 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 922 | # it is also possible to disable source filtering for a specific pattern using 923 | # *.ext= (so without naming a filter). 924 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 925 | 926 | FILTER_SOURCE_PATTERNS = 927 | 928 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 929 | # is part of the input, its contents will be placed on the main page 930 | # (index.html). This can be useful if you have a project on for instance GitHub 931 | # and want to reuse the introduction page also for the doxygen output. 932 | 933 | USE_MDFILE_AS_MAINPAGE = 934 | 935 | #--------------------------------------------------------------------------- 936 | # Configuration options related to source browsing 937 | #--------------------------------------------------------------------------- 938 | 939 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 940 | # generated. Documented entities will be cross-referenced with these sources. 941 | # 942 | # Note: To get rid of all source code in the generated output, make sure that 943 | # also VERBATIM_HEADERS is set to NO. 944 | # The default value is: NO. 945 | 946 | SOURCE_BROWSER = NO 947 | 948 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 949 | # classes and enums directly into the documentation. 950 | # The default value is: NO. 951 | 952 | INLINE_SOURCES = NO 953 | 954 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 955 | # special comment blocks from generated source code fragments. Normal C, C++ and 956 | # Fortran comments will always remain visible. 957 | # The default value is: YES. 958 | 959 | STRIP_CODE_COMMENTS = YES 960 | 961 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 962 | # function all documented functions referencing it will be listed. 963 | # The default value is: NO. 964 | 965 | REFERENCED_BY_RELATION = NO 966 | 967 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 968 | # all documented entities called/used by that function will be listed. 969 | # The default value is: NO. 970 | 971 | REFERENCES_RELATION = NO 972 | 973 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 974 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 975 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 976 | # link to the documentation. 977 | # The default value is: YES. 978 | 979 | REFERENCES_LINK_SOURCE = YES 980 | 981 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 982 | # source code will show a tooltip with additional information such as prototype, 983 | # brief description and links to the definition and documentation. Since this 984 | # will make the HTML file larger and loading of large files a bit slower, you 985 | # can opt to disable this feature. 986 | # The default value is: YES. 987 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 988 | 989 | SOURCE_TOOLTIPS = YES 990 | 991 | # If the USE_HTAGS tag is set to YES then the references to source code will 992 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 993 | # source browser. The htags tool is part of GNU's global source tagging system 994 | # (see https://www.gnu.org/software/global/global.html). You will need version 995 | # 4.8.6 or higher. 996 | # 997 | # To use it do the following: 998 | # - Install the latest version of global 999 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1000 | # - Make sure the INPUT points to the root of the source tree 1001 | # - Run doxygen as normal 1002 | # 1003 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1004 | # tools must be available from the command line (i.e. in the search path). 1005 | # 1006 | # The result: instead of the source browser generated by doxygen, the links to 1007 | # source code will now point to the output of htags. 1008 | # The default value is: NO. 1009 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1010 | 1011 | USE_HTAGS = NO 1012 | 1013 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1014 | # verbatim copy of the header file for each class for which an include is 1015 | # specified. Set to NO to disable this. 1016 | # See also: Section \class. 1017 | # The default value is: YES. 1018 | 1019 | VERBATIM_HEADERS = YES 1020 | 1021 | #--------------------------------------------------------------------------- 1022 | # Configuration options related to the alphabetical class index 1023 | #--------------------------------------------------------------------------- 1024 | 1025 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1026 | # compounds will be generated. Enable this if the project contains a lot of 1027 | # classes, structs, unions or interfaces. 1028 | # The default value is: YES. 1029 | 1030 | ALPHABETICAL_INDEX = YES 1031 | 1032 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1033 | # which the alphabetical index list will be split. 1034 | # Minimum value: 1, maximum value: 20, default value: 5. 1035 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1036 | 1037 | COLS_IN_ALPHA_INDEX = 5 1038 | 1039 | # In case all classes in a project start with a common prefix, all classes will 1040 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1041 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1042 | # while generating the index headers. 1043 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1044 | 1045 | IGNORE_PREFIX = 1046 | 1047 | #--------------------------------------------------------------------------- 1048 | # Configuration options related to the HTML output 1049 | #--------------------------------------------------------------------------- 1050 | 1051 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1052 | # The default value is: YES. 1053 | 1054 | GENERATE_HTML = YES 1055 | 1056 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1057 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1058 | # it. 1059 | # The default directory is: html. 1060 | # This tag requires that the tag GENERATE_HTML is set to YES. 1061 | 1062 | HTML_OUTPUT = html 1063 | 1064 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1065 | # generated HTML page (for example: .htm, .php, .asp). 1066 | # The default value is: .html. 1067 | # This tag requires that the tag GENERATE_HTML is set to YES. 1068 | 1069 | HTML_FILE_EXTENSION = .html 1070 | 1071 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1072 | # each generated HTML page. If the tag is left blank doxygen will generate a 1073 | # standard header. 1074 | # 1075 | # To get valid HTML the header file that includes any scripts and style sheets 1076 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1077 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1078 | # default header using 1079 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1080 | # YourConfigFile 1081 | # and then modify the file new_header.html. See also section "Doxygen usage" 1082 | # for information on how to generate the default header that doxygen normally 1083 | # uses. 1084 | # Note: The header is subject to change so you typically have to regenerate the 1085 | # default header when upgrading to a newer version of doxygen. For a description 1086 | # of the possible markers and block names see the documentation. 1087 | # This tag requires that the tag GENERATE_HTML is set to YES. 1088 | 1089 | HTML_HEADER = 1090 | 1091 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1092 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1093 | # footer. See HTML_HEADER for more information on how to generate a default 1094 | # footer and what special commands can be used inside the footer. See also 1095 | # section "Doxygen usage" for information on how to generate the default footer 1096 | # that doxygen normally uses. 1097 | # This tag requires that the tag GENERATE_HTML is set to YES. 1098 | 1099 | HTML_FOOTER = 1100 | 1101 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1102 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1103 | # the HTML output. If left blank doxygen will generate a default style sheet. 1104 | # See also section "Doxygen usage" for information on how to generate the style 1105 | # sheet that doxygen normally uses. 1106 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1107 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1108 | # obsolete. 1109 | # This tag requires that the tag GENERATE_HTML is set to YES. 1110 | 1111 | HTML_STYLESHEET = 1112 | 1113 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1114 | # cascading style sheets that are included after the standard style sheets 1115 | # created by doxygen. Using this option one can overrule certain style aspects. 1116 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1117 | # standard style sheet and is therefore more robust against future updates. 1118 | # Doxygen will copy the style sheet files to the output directory. 1119 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1120 | # style sheet in the list overrules the setting of the previous ones in the 1121 | # list). For an example see the documentation. 1122 | # This tag requires that the tag GENERATE_HTML is set to YES. 1123 | 1124 | HTML_EXTRA_STYLESHEET = 1125 | 1126 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1127 | # other source files which should be copied to the HTML output directory. Note 1128 | # that these files will be copied to the base HTML output directory. Use the 1129 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1130 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1131 | # files will be copied as-is; there are no commands or markers available. 1132 | # This tag requires that the tag GENERATE_HTML is set to YES. 1133 | 1134 | HTML_EXTRA_FILES = 1135 | 1136 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1137 | # will adjust the colors in the style sheet and background images according to 1138 | # this color. Hue is specified as an angle on a colorwheel, see 1139 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1140 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1141 | # purple, and 360 is red again. 1142 | # Minimum value: 0, maximum value: 359, default value: 220. 1143 | # This tag requires that the tag GENERATE_HTML is set to YES. 1144 | 1145 | HTML_COLORSTYLE_HUE = 220 1146 | 1147 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1148 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1149 | # value of 255 will produce the most vivid colors. 1150 | # Minimum value: 0, maximum value: 255, default value: 100. 1151 | # This tag requires that the tag GENERATE_HTML is set to YES. 1152 | 1153 | HTML_COLORSTYLE_SAT = 100 1154 | 1155 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1156 | # luminance component of the colors in the HTML output. Values below 100 1157 | # gradually make the output lighter, whereas values above 100 make the output 1158 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1159 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1160 | # change the gamma. 1161 | # Minimum value: 40, maximum value: 240, default value: 80. 1162 | # This tag requires that the tag GENERATE_HTML is set to YES. 1163 | 1164 | HTML_COLORSTYLE_GAMMA = 80 1165 | 1166 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1167 | # page will contain the date and time when the page was generated. Setting this 1168 | # to YES can help to show when doxygen was last run and thus if the 1169 | # documentation is up to date. 1170 | # The default value is: NO. 1171 | # This tag requires that the tag GENERATE_HTML is set to YES. 1172 | 1173 | HTML_TIMESTAMP = NO 1174 | 1175 | # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1176 | # documentation will contain a main index with vertical navigation menus that 1177 | # are dynamically created via Javascript. If disabled, the navigation index will 1178 | # consists of multiple levels of tabs that are statically embedded in every HTML 1179 | # page. Disable this option to support browsers that do not have Javascript, 1180 | # like the Qt help browser. 1181 | # The default value is: YES. 1182 | # This tag requires that the tag GENERATE_HTML is set to YES. 1183 | 1184 | HTML_DYNAMIC_MENUS = YES 1185 | 1186 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1187 | # documentation will contain sections that can be hidden and shown after the 1188 | # page has loaded. 1189 | # The default value is: NO. 1190 | # This tag requires that the tag GENERATE_HTML is set to YES. 1191 | 1192 | HTML_DYNAMIC_SECTIONS = NO 1193 | 1194 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1195 | # shown in the various tree structured indices initially; the user can expand 1196 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1197 | # such a level that at most the specified number of entries are visible (unless 1198 | # a fully collapsed tree already exceeds this amount). So setting the number of 1199 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1200 | # representing an infinite number of entries and will result in a full expanded 1201 | # tree by default. 1202 | # Minimum value: 0, maximum value: 9999, default value: 100. 1203 | # This tag requires that the tag GENERATE_HTML is set to YES. 1204 | 1205 | HTML_INDEX_NUM_ENTRIES = 100 1206 | 1207 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1208 | # generated that can be used as input for Apple's Xcode 3 integrated development 1209 | # environment (see: https://developer.apple.com/tools/xcode/), introduced with 1210 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1211 | # Makefile in the HTML output directory. Running make will produce the docset in 1212 | # that directory and running make install will install the docset in 1213 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1214 | # startup. See https://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1215 | # for more information. 1216 | # The default value is: NO. 1217 | # This tag requires that the tag GENERATE_HTML is set to YES. 1218 | 1219 | GENERATE_DOCSET = NO 1220 | 1221 | # This tag determines the name of the docset feed. A documentation feed provides 1222 | # an umbrella under which multiple documentation sets from a single provider 1223 | # (such as a company or product suite) can be grouped. 1224 | # The default value is: Doxygen generated docs. 1225 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1226 | 1227 | DOCSET_FEEDNAME = "Doxygen generated docs" 1228 | 1229 | # This tag specifies a string that should uniquely identify the documentation 1230 | # set bundle. This should be a reverse domain-name style string, e.g. 1231 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1232 | # The default value is: org.doxygen.Project. 1233 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1234 | 1235 | DOCSET_BUNDLE_ID = org.doxygen.Project 1236 | 1237 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1238 | # the documentation publisher. This should be a reverse domain-name style 1239 | # string, e.g. com.mycompany.MyDocSet.documentation. 1240 | # The default value is: org.doxygen.Publisher. 1241 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1242 | 1243 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1244 | 1245 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1246 | # The default value is: Publisher. 1247 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1248 | 1249 | DOCSET_PUBLISHER_NAME = Publisher 1250 | 1251 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1252 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1253 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1254 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1255 | # Windows. 1256 | # 1257 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1258 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1259 | # files are now used as the Windows 98 help format, and will replace the old 1260 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1261 | # HTML files also contain an index, a table of contents, and you can search for 1262 | # words in the documentation. The HTML workshop also contains a viewer for 1263 | # compressed HTML files. 1264 | # The default value is: NO. 1265 | # This tag requires that the tag GENERATE_HTML is set to YES. 1266 | 1267 | GENERATE_HTMLHELP = NO 1268 | 1269 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1270 | # file. You can add a path in front of the file if the result should not be 1271 | # written to the html output directory. 1272 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1273 | 1274 | CHM_FILE = 1275 | 1276 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1277 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1278 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1279 | # The file has to be specified with full path. 1280 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1281 | 1282 | HHC_LOCATION = 1283 | 1284 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1285 | # (YES) or that it should be included in the master .chm file (NO). 1286 | # The default value is: NO. 1287 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1288 | 1289 | GENERATE_CHI = NO 1290 | 1291 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1292 | # and project file content. 1293 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1294 | 1295 | CHM_INDEX_ENCODING = 1296 | 1297 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1298 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1299 | # enables the Previous and Next buttons. 1300 | # The default value is: NO. 1301 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1302 | 1303 | BINARY_TOC = NO 1304 | 1305 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1306 | # the table of contents of the HTML help documentation and to the tree view. 1307 | # The default value is: NO. 1308 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1309 | 1310 | TOC_EXPAND = NO 1311 | 1312 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1313 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1314 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1315 | # (.qch) of the generated HTML documentation. 1316 | # The default value is: NO. 1317 | # This tag requires that the tag GENERATE_HTML is set to YES. 1318 | 1319 | GENERATE_QHP = NO 1320 | 1321 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1322 | # the file name of the resulting .qch file. The path specified is relative to 1323 | # the HTML output folder. 1324 | # This tag requires that the tag GENERATE_QHP is set to YES. 1325 | 1326 | QCH_FILE = 1327 | 1328 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1329 | # Project output. For more information please see Qt Help Project / Namespace 1330 | # (see: http://doc.qt.io/qt-4.8/qthelpproject.html#namespace). 1331 | # The default value is: org.doxygen.Project. 1332 | # This tag requires that the tag GENERATE_QHP is set to YES. 1333 | 1334 | QHP_NAMESPACE = org.doxygen.Project 1335 | 1336 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1337 | # Help Project output. For more information please see Qt Help Project / Virtual 1338 | # Folders (see: http://doc.qt.io/qt-4.8/qthelpproject.html#virtual-folders). 1339 | # The default value is: doc. 1340 | # This tag requires that the tag GENERATE_QHP is set to YES. 1341 | 1342 | QHP_VIRTUAL_FOLDER = doc 1343 | 1344 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1345 | # filter to add. For more information please see Qt Help Project / Custom 1346 | # Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). 1347 | # This tag requires that the tag GENERATE_QHP is set to YES. 1348 | 1349 | QHP_CUST_FILTER_NAME = 1350 | 1351 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1352 | # custom filter to add. For more information please see Qt Help Project / Custom 1353 | # Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). 1354 | # This tag requires that the tag GENERATE_QHP is set to YES. 1355 | 1356 | QHP_CUST_FILTER_ATTRS = 1357 | 1358 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1359 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1360 | # http://doc.qt.io/qt-4.8/qthelpproject.html#filter-attributes). 1361 | # This tag requires that the tag GENERATE_QHP is set to YES. 1362 | 1363 | QHP_SECT_FILTER_ATTRS = 1364 | 1365 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1366 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1367 | # generated .qhp file. 1368 | # This tag requires that the tag GENERATE_QHP is set to YES. 1369 | 1370 | QHG_LOCATION = 1371 | 1372 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1373 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1374 | # install this plugin and make it available under the help contents menu in 1375 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1376 | # to be copied into the plugins directory of eclipse. The name of the directory 1377 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1378 | # After copying Eclipse needs to be restarted before the help appears. 1379 | # The default value is: NO. 1380 | # This tag requires that the tag GENERATE_HTML is set to YES. 1381 | 1382 | GENERATE_ECLIPSEHELP = NO 1383 | 1384 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1385 | # the directory name containing the HTML and XML files should also have this 1386 | # name. Each documentation set should have its own identifier. 1387 | # The default value is: org.doxygen.Project. 1388 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1389 | 1390 | ECLIPSE_DOC_ID = org.doxygen.Project 1391 | 1392 | # If you want full control over the layout of the generated HTML pages it might 1393 | # be necessary to disable the index and replace it with your own. The 1394 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1395 | # of each HTML page. A value of NO enables the index and the value YES disables 1396 | # it. Since the tabs in the index contain the same information as the navigation 1397 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1398 | # The default value is: NO. 1399 | # This tag requires that the tag GENERATE_HTML is set to YES. 1400 | 1401 | DISABLE_INDEX = NO 1402 | 1403 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1404 | # structure should be generated to display hierarchical information. If the tag 1405 | # value is set to YES, a side panel will be generated containing a tree-like 1406 | # index structure (just like the one that is generated for HTML Help). For this 1407 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1408 | # (i.e. any modern browser). Windows users are probably better off using the 1409 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1410 | # further fine-tune the look of the index. As an example, the default style 1411 | # sheet generated by doxygen has an example that shows how to put an image at 1412 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1413 | # the same information as the tab index, you could consider setting 1414 | # DISABLE_INDEX to YES when enabling this option. 1415 | # The default value is: NO. 1416 | # This tag requires that the tag GENERATE_HTML is set to YES. 1417 | 1418 | GENERATE_TREEVIEW = NO 1419 | 1420 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1421 | # doxygen will group on one line in the generated HTML documentation. 1422 | # 1423 | # Note that a value of 0 will completely suppress the enum values from appearing 1424 | # in the overview section. 1425 | # Minimum value: 0, maximum value: 20, default value: 4. 1426 | # This tag requires that the tag GENERATE_HTML is set to YES. 1427 | 1428 | ENUM_VALUES_PER_LINE = 4 1429 | 1430 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1431 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1432 | # Minimum value: 0, maximum value: 1500, default value: 250. 1433 | # This tag requires that the tag GENERATE_HTML is set to YES. 1434 | 1435 | TREEVIEW_WIDTH = 250 1436 | 1437 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1438 | # external symbols imported via tag files in a separate window. 1439 | # The default value is: NO. 1440 | # This tag requires that the tag GENERATE_HTML is set to YES. 1441 | 1442 | EXT_LINKS_IN_WINDOW = NO 1443 | 1444 | # Use this tag to change the font size of LaTeX formulas included as images in 1445 | # the HTML documentation. When you change the font size after a successful 1446 | # doxygen run you need to manually remove any form_*.png images from the HTML 1447 | # output directory to force them to be regenerated. 1448 | # Minimum value: 8, maximum value: 50, default value: 10. 1449 | # This tag requires that the tag GENERATE_HTML is set to YES. 1450 | 1451 | FORMULA_FONTSIZE = 10 1452 | 1453 | # Use the FORMULA_TRANSPARENT tag to determine whether or not the images 1454 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1455 | # supported properly for IE 6.0, but are supported on all modern browsers. 1456 | # 1457 | # Note that when changing this option you need to delete any form_*.png files in 1458 | # the HTML output directory before the changes have effect. 1459 | # The default value is: YES. 1460 | # This tag requires that the tag GENERATE_HTML is set to YES. 1461 | 1462 | FORMULA_TRANSPARENT = YES 1463 | 1464 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1465 | # https://www.mathjax.org) which uses client side Javascript for the rendering 1466 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1467 | # installed or if you want to formulas look prettier in the HTML output. When 1468 | # enabled you may also need to install MathJax separately and configure the path 1469 | # to it using the MATHJAX_RELPATH option. 1470 | # The default value is: NO. 1471 | # This tag requires that the tag GENERATE_HTML is set to YES. 1472 | 1473 | USE_MATHJAX = NO 1474 | 1475 | # When MathJax is enabled you can set the default output format to be used for 1476 | # the MathJax output. See the MathJax site (see: 1477 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1478 | # Possible values are: HTML-CSS (which is slower, but has the best 1479 | # compatibility), NativeMML (i.e. MathML) and SVG. 1480 | # The default value is: HTML-CSS. 1481 | # This tag requires that the tag USE_MATHJAX is set to YES. 1482 | 1483 | MATHJAX_FORMAT = HTML-CSS 1484 | 1485 | # When MathJax is enabled you need to specify the location relative to the HTML 1486 | # output directory using the MATHJAX_RELPATH option. The destination directory 1487 | # should contain the MathJax.js script. For instance, if the mathjax directory 1488 | # is located at the same level as the HTML output directory, then 1489 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1490 | # Content Delivery Network so you can quickly see the result without installing 1491 | # MathJax. However, it is strongly recommended to install a local copy of 1492 | # MathJax from https://www.mathjax.org before deployment. 1493 | # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/. 1494 | # This tag requires that the tag USE_MATHJAX is set to YES. 1495 | 1496 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1497 | 1498 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1499 | # extension names that should be enabled during MathJax rendering. For example 1500 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1501 | # This tag requires that the tag USE_MATHJAX is set to YES. 1502 | 1503 | MATHJAX_EXTENSIONS = 1504 | 1505 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1506 | # of code that will be used on startup of the MathJax code. See the MathJax site 1507 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1508 | # example see the documentation. 1509 | # This tag requires that the tag USE_MATHJAX is set to YES. 1510 | 1511 | MATHJAX_CODEFILE = 1512 | 1513 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1514 | # the HTML output. The underlying search engine uses javascript and DHTML and 1515 | # should work on any modern browser. Note that when using HTML help 1516 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1517 | # there is already a search function so this one should typically be disabled. 1518 | # For large projects the javascript based search engine can be slow, then 1519 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1520 | # search using the keyboard; to jump to the search box use + S 1521 | # (what the is depends on the OS and browser, but it is typically 1522 | # , /