Comments (4)
The API is part of the user's guide that gets generated using doxygen. Typically we'd attach the generated file for official releases but it has been a while since we've had one. https://github.com/nasa/cFS/pull/40/files contains steps to build the documentation, but we've currently got a bug in creating the pdf (although html does work). I'll work to get the bug resolved and update once complete.
from cfs.
See attached for the current autogenerated documentation that includes the cFE APIs. It is undergoing updates, but at least a good start.
from cfs.
from cfs.
Note there are a few out of date comments, but I'm working them now.
from cfs.
Related Issues (20)
- Question about Apache-2.0 in space HOT 1
- cFS Draco Release HOT 4
- Update format check workflow to newer clang-format version HOT 2
- cFS Caelum Release
- missing PUS lib repo HOT 1
- OSAL workflow "Static Analysis" fails to convert cppcheck results to SARIF HOT 2
- Revisit "format-check" workflow - is it needed? HOT 8
- build doc run session 1980
- Do not know how to set CFE_SYSTEM_PSPNAME on Darwin system HOT 2
- Section 1.8 of userguide.pdf has duplicate entries.
- Github workflow does not allow enough time for all Functional tests to run
- Header Guards for C++ applications to call CFE, OSAL, PSP
- Create unit test for vxworks_sysmon HOT 1
- Large object pushed on stack by function UT_CallTaskPipe()
- TOC links not working in CONTRIBUTING.md
- Renaming the project name to the name of the containing folder causes make SIMULATION=native prep to fail HOT 8
- Consider analyzing conditionals for mc/dc coverage HOT 2
- Remove format check on PR title
- Shared workflow scripts need updates for node.js version
- 79 - coverage-es-ALL (SEGFAULT) HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from cfs.