Don Cross
318ea259dc
Fixed a typo in the documentation for Astronomy_Seasons.
2019-06-03 14:19:16 -04:00
Don Cross
60e2644f8f
Added documentation for C function Astronomy_Seasons.
...
Also modified hydrogen.js to enclose function parameter names
inside a code block.
2019-06-03 14:13:24 -04:00
Don Cross
bf4ec1b057
Added documentation for C function Astronomy_Search.
2019-06-02 21:07:42 -04:00
Don Cross
a80d4899f3
Added documentation for C function Astronomy_EclipticLongitude.
2019-06-02 16:11:17 -04:00
Don Cross
abda37086d
Added documentation for C function Astronomy_Ecliptic.
2019-06-02 16:01:48 -04:00
Don Cross
c03d12952e
Eliminate potential thread-safety problem in Astronomy_Ecliptic.
...
Hardcode the mean obliquity of the ecliptic at J2000 instead of lazy-evaluating it.
This change eliminates a potential thread-safety issue.
2019-06-02 15:44:32 -04:00
Don Cross
1744b7c72e
Added documentation for C function Astronomy_SunPosition.
2019-06-02 15:33:12 -04:00
Don Cross
5a9550b8db
Added documentation for C function Astronomy_Horizon.
2019-06-02 14:34:53 -04:00
Don Cross
4bb1c73c10
C: replace magic numbers with enumerated types. Added documentation.
...
The following functions had parameters that accepted cryptic numeric values:
Astronomy_GeoVector
Astronomy_Equator
Astronomy_SearchRiseSet
Replaced such parameters with enumerations. Added the following enumerated types:
astro_aberration_t
astro_direction_t
astro_equator_date_t
Added more C documentation.
2019-06-02 13:34:30 -04:00
Don Cross
2e638da314
More work on C documentation. Tweaks to JS documentation.
2019-06-02 11:45:45 -04:00
Don Cross
1054042330
Added more documentation of C functions.
2019-06-01 22:10:28 -04:00
Don Cross
c6845c2d58
Generate documentation for C typedefs.
2019-06-01 21:00:58 -04:00
Don Cross
5bcaad1ac3
Added tables of contents with links to sections.
2019-06-01 20:27:16 -04:00
Don Cross
ee83dde084
Use code blocks for enum type names.
2019-06-01 20:07:48 -04:00
Don Cross
1091cc9ea7
Nope, trying to add links to enum values did not work.
2019-06-01 19:47:31 -04:00
Don Cross
2153e12181
Experiment with adding intra-document links to enum values.
...
I have a feeling this won't work, but at least I should try it.
2019-06-01 19:42:06 -04:00
Don Cross
14ba63eab5
hydrogen: Documenting C enumeration types.
2019-06-01 18:24:17 -04:00
Don Cross
83190bab8a
hydrogen: Make parameter table header names consistent.
2019-06-01 16:24:24 -04:00
Don Cross
a1fe941837
hydrogen: generating markdown for C function parameter doxygen comments.
2019-06-01 16:22:43 -04:00
Don Cross
3f39cafb2f
Include comma separated list of function parameter names.
2019-06-01 15:24:59 -04:00
Don Cross
6526adb540
More formatting improvements.
2019-05-31 21:05:18 -04:00
Don Cross
957550f716
Improve style of struct descriptions in C documentation.
2019-05-31 20:47:31 -04:00
Don Cross
848cf18a21
Style tweak for C function documentation.
2019-05-31 20:46:06 -04:00
Don Cross
95cb34fce5
hydrogen: More work on documenting C functions.
2019-05-31 20:40:42 -04:00
Don Cross
5c110eef8e
hydrogen: Do not use code block for function prototypes: too ugly!
2019-05-31 19:44:33 -04:00
Don Cross
c8d56881bd
Starting to generate markdown for C function prototypes.
2019-05-31 18:02:49 -04:00
Don Cross
afbec20b79
Link to other types from tables describing struct members.
2019-05-30 21:40:43 -04:00
Don Cross
64b513b67f
More work on C documentation processor.
2019-05-30 21:28:50 -04:00
Don Cross
515e32a5ee
Fixed internal links to symbols. Fixed some typos.
2019-05-30 21:19:03 -04:00
Don Cross
937789e9b4
Render descriptions of structs in C documentation.
2019-05-30 21:12:58 -04:00
Don Cross
01220ed5aa
Add space before paragraph elements.
2019-05-30 20:55:29 -04:00
Don Cross
fd16d8d58c
Make type column come before member column in struct tables.
...
It makes more sense for the C documentation of structs to
have the type come first, then the struct member name,
because it reads more like actual C code that way.
2019-05-30 20:48:04 -04:00
Don Cross
07b2d6e9b4
Another attempt to fix markdown boldface.
2019-05-30 20:45:51 -04:00
Don Cross
fd03142462
Experiment to get boldface tags working in kramdown.
2019-05-30 20:43:58 -04:00
Don Cross
abea7fe720
Giving up on using html paragraphs inside kramdown tables for now.
2019-05-30 20:35:30 -04:00
Don Cross
ca87caaac5
Another attempt to get kramdown and github to both render paragraphs inside tables.
2019-05-30 20:20:49 -04:00
Don Cross
5c258c5f2b
Third attempt to get html to render correctly on github.com and gh-pages.
2019-05-30 17:56:50 -04:00
Don Cross
1938c2ab98
Second attempt to prevent gh-pages (kramdown) escaping html inside tables.
2019-05-30 17:54:21 -04:00
Don Cross
de42c967d7
Trying to get html to render correctly inside tables in gh-pages.
2019-05-30 17:46:53 -04:00
Don Cross
c8a0300ac0
hydrogen: trying to format paragraphs within tables.
2019-05-30 17:19:01 -04:00
Don Cross
ae201d1db6
Needed another blank line after the last structure table.
2019-05-30 15:57:58 -04:00
Don Cross
77d1b8d9c4
Total guessing game trying to get Markdown tables to render.
...
I don't understand the weird differences between rendering rules
on github.io and github.com. Maybe table headers need to begin
with capital letters?
2019-05-30 15:50:54 -04:00
Don Cross
645e00b7bf
one more attempt to get structure tables rendering.
2019-05-30 15:45:44 -04:00
Don Cross
2e720df94c
Update C documentation.
2019-05-30 15:44:45 -04:00
Don Cross
d26fa48d44
hydrogen: Starting to render Markdown for structure fields.
2019-05-30 15:40:38 -04:00
Don Cross
65e380e59c
Trying to get tables to render on github.com; adding headers.
2019-05-28 21:30:45 -04:00
Don Cross
be735decb3
Shot in the dark... trying to fix wonky README.
2019-05-28 21:22:50 -04:00
Don Cross
e063644970
hydrogen: work in progress.
2019-05-28 19:11:30 -04:00
Don Cross
5cda9bd68e
Added lots more C documentation in doxygen-formatted comments.
2019-05-28 15:56:06 -04:00
Don Cross
5f9ebb2c8b
Removed iteration counts from search results. Renamed SearchError function.
...
I don't want to mix performance information with results.
If I need performance information later, I can do it through
a side channel. Renamed SearchErr to SearchError, to be consistent
with the other functions that generate error structs.
2019-05-28 08:08:30 -04:00