aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/Doxyfile.in
Commit message (Collapse)AuthorAgeFilesLines
* docs: Fix Doxygen warningsMartin Braun2022-03-141-14/+1
| | | | | | - Removed variables that have been deprecated in newer Doxygen versions - Replaced <speedgrade> with $speedgrade in E310 manual; Doxygen thinks it's an HTML tag.
* cmake: doxygen: Make MATHJAX_RELPATH configurable via CMakeMartin Braun2022-02-241-1/+1
| | | | | | | | | | | | | | | | | This is a Doxygen setting where to find MathJax. The default might not be suitable for everyone, and in particular, if people already have MJ installed on their local system, they might prefer using that instead of an online one. Example usage: Assume you have MathJax installed locally, e.g., through the mathjax package on Fedora, or the libjs-mathjax package on Debian/Ubuntu. Then you could build UHD as such: cmake -DMATHJAX_RELPATH=/usr/share/javascript/mathjax This will now use the local version. Note that locally generated HTML documentation can now no longer be copied to other machines, unless they also have MathJax installed to the same path.
* docs: Remove full path names from Doxygen generationMartin Braun2022-02-111-1/+1
| | | | | The full path names can cause non-reproducible builds, because they include the build directory.
* docs: Fix MathJax formulae renderingAaron Rossetto2021-12-161-1/+1
| | | | | | | | | | When a webpage is accessed via secure HTTP, and that webpage attempts to address active content via a non-secure URI, most modern browsers will block the loading of that content as a security precaution. In this case, the URI to the MathJax JavaScript rendering library was specified in the Doxygen configuration with an HTTP (i.e., non-encrypted) URI, thus preventing the browser from loading it and rendering formulae correctly.
* cmake: Replace CMAKE_{SOURCE,BINARY}_DIR with UHD_*_DIRMartin Braun2021-09-101-7/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | See the CMake 3.8 documentation on these two variables: https://cmake.org/cmake/help/v3.8/variable/PROJECT-NAME_SOURCE_DIR.html https://cmake.org/cmake/help/v3.8/variable/CMAKE_SOURCE_DIR.html Under normal circumstances, these two are identical. For sub-projects (i.e., when building UHD as part of something else that is also a CMake project), only the former is useful. There is no discernible downside of using UHD_SOURCE_DIR over CMAKE_SOURCE_DIR. This was changed using sed: $ sed -i "s/CMAKE_SOURCE_DIR/UHD_SOURCE_DIR/g" \ `ag -l CMAKE_SOURCE_DIR **/{CMakeLists.txt,*.cmake}` $ sed -i "s/CMAKE_BINARY_DIR/UHD_BINARY_DIR/g" \ `ag -l CMAKE_BINARY_DIR **/{CMakeLists.txt,*.cmake}` At the same time, we also replace the CMake variable UHD_HOST_ROOT (used in MPM) with UHD_SOURCE_DIR. There's no reason to have two variables with the same meaning and different names, but more importantly, this means that UHD_SOURCE_DIR is defined even in those cases where MPM calls into CMake files from UHD without any additional patches. Shoutout to GitHub user marcobergamin for bringing this up.
* docs: Use Mathjax for equation renderingMartin Braun2021-03-191-1/+1
|
* docs: Fix some Doxygen warningsMartin Braun2020-05-201-2/+2
| | | | | Disables CLANG_ASSISTED_PARSING and CLANG_OPTIONS, which are not available in all Doxygen version, and are unused.
* uhd: doc: Fix Doxygen warnings on 1.8.13Aaron Rossetto2020-05-051-22/+77
|
* uhd: doc: fixed doxygen deprecation warningsLars Amsel2020-05-041-952/+1604
| | | | | removed doxgen deprecation warnings by running `doxygen -u` against Doxygen.in
* uhd: cal: Add iq_cal calibration data container classMartin Braun2020-04-021-1/+1
| | | | | | | | This class can be used to store calibration coefficients for the X300 DC offset and IQ imbalance calibration. Note: This also modifies Doxyfile.in to not document files generated by flatc.
* Docs: Add stub of RFNoC docsMartin Braun2018-06-221-1/+1
|
* python: Separating exposed Python data structuresPaul David2018-06-201-1/+1
| | | | | | | | | - Separating exposed Python data structures into logical sections - Exposes all of the multi_usrp API - Adds a layer of Python for documentation and adding helper methods - Adds improvements and fixes to the MultiUSRP object - Includes additional exposed data structures (like time_spec_t, etc.) - Add code to release the Python GIL during long C++ calls
* Docs: Hide dependencies directory from DoxygenDerek Kozel2018-03-261-1/+2
|
* doxygen: Exclude RFNoC includes if ENABLE_RFNOC is offMartin Braun2016-08-121-1/+1
|
* docs: no HTML timestamp for DoxygenNicholas Corgan2016-06-141-1/+1
|
* doxygen/cmake: Allow Doxygen to use shorter filenamesMartin Braun2016-05-051-1/+1
| | | | | This fixes cases where automatic builds fail on operating systems with character limits in paths, such as Windows.
* cmake: Enable use of dot for DoxygenMartin Braun2016-04-071-1/+1
|
* docs: Removed some Doxygen warningsMartin Braun2015-10-081-12/+0
|
* docs: Less noisy Doxygen while building manualMartin Braun2015-09-151-1/+1
|
* docs: Track doc updates on fpga-srcMartin Braun2015-04-301-1/+1
|
* docs: Added FPGA manualMartin Braun2015-04-271-3/+3
| | | | | | | | The actual FPGA manual pages are in the FPGA repository. Only if the submodule is checked out will it build the manual pages. If the submodule is not checked out, it will create a link to the FPGA manual hosted online.
* doxygen: ignore NI-RIO filesNicholas Corgan2015-03-241-1/+2
|
* docs: Cleaned up and rearranged manual structureMartin Braun2014-10-141-1/+1
| | | | | - Removed stray .rst files - Cleared up TOC, manual is now split into two parts
* doxygen: readded removed STRIP_FROM_INC_PATH patch for correct include pathsNicholas Corgan2014-04-101-1/+1
|
* docs: Adjusted CMake so Doxygen builds either manual, API docs, or bothMartin Braun2014-04-091-2/+2
|
* docs: Moved manual to DoxygenMartin Braun2014-04-091-154/+530
|
* Created a docs directory to house restructured text documentation.Josh Blum2010-04-181-0/+1514
Moved doxygen build rules into the docs build directory. Created rst docs for building and burning usrp2.
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-27 08:40:36 +0000