Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide a walk through of the main components of the ECI #27

Open
BaldBeacon opened this issue Aug 7, 2019 · 0 comments
Open

Provide a walk through of the main components of the ECI #27

BaldBeacon opened this issue Aug 7, 2019 · 0 comments
Assignees
Labels
documentation Update documentation

Comments

@BaldBeacon
Copy link
Contributor

We've had a large amount of questions asking for an introduction to how to configure the ECI. This should be part of a larger scale effort to document ECI up to a standard of basic usability.

@BaldBeacon BaldBeacon added the documentation Update documentation label Aug 7, 2019
BaldBeacon added a commit that referenced this issue Aug 7, 2019
Close #27
As an effort to begin comprehensive documentation of the ECI,
this commit creates a main page for doxygen and an explaination of how to build
eci_interface.h. Since the simple app's eci_interface.h was using normal
C style comments instead of doxygen comments, these were converted for
the documentation. So far, there wasn't a need to convert the sgp4 app
since it's not referenced. The last change was to remove the value after
every macro defined in the simple app's interface file. The comments mention
it can be anything but it makes more sense to just define the macro
without a value.
@BaldBeacon BaldBeacon self-assigned this Aug 7, 2019
BaldBeacon added a commit that referenced this issue Aug 12, 2019
Close #27
As an effort to begin comprehensive documentation of the ECI,
this commit creates a main page for doxygen and an explaination of how to build
eci_interface.h. Since the simple app's eci_interface.h was using normal
C style comments instead of doxygen comments, these were converted for
the documentation. So far, there wasn't a need to convert the sgp4 app
since it's not referenced. The last change was to remove the value after
every macro defined in the simple app's interface file. The comments mention
it can be anything but it makes more sense to just define the macro
without a value.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Update documentation
Projects
None yet
Development

No branches or pull requests

1 participant