Commit Graph

213 Commits

Author SHA1 Message Date
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
Don Cross
9128d42f1e Added a little more C documentation. 2019-05-28 07:55:25 -04:00
Don Cross
6429a8f8b5 Added more documentation for C code. 2019-05-27 20:46:08 -04:00
Don Cross
57fea25f3a hydrogen: Added prefix template. Added internal links to items. 2019-05-27 19:41:53 -04:00
Don Cross
b23a0316a8 To find structs, need to process other xml files. Merge all xml.
It turns out it simplifies things to merge all the doxygen xml
files into a single all.xml file, then process that. That way
I can find all the struct definitions too.
2019-05-27 19:01:25 -04:00
Don Cross
01251b5fc7 hydrogen: starting to understand doxygen xml format better. 2019-05-27 15:16:57 -04:00
Don Cross
f8001db8d0 More work on custom translation of doxygen xml to markdown. 2019-05-27 09:25:58 -04:00
Don Cross
63474a29d0 Work in progress: hydrogen 2019-05-26 21:22:23 -04:00
Don Cross
2dc6124f79 Explicitly specify astronomy.c and astronomy.h for doxygen.
I don't want doxygen processing any other files to generate
C documentation. I see that it can pull in .md files, which
could cause problems later.
2019-05-26 20:47:54 -04:00
Don Cross
118a224921 Removing moxygen. I'm going to create my own custom doxygen-to-markdown. 2019-05-26 20:32:57 -04:00
Don Cross
cbdef29197 Starting to experiment with moxygen custom templates.
I don't know if this is going to do what I want, but I'm
hoping I can customize the Markdown output generated by moxygen
to be useful for a simple C library like this. It appears to be
customized for a class-oriented C++ program.
2019-05-26 17:43:23 -04:00
Don Cross
83b1504552 Fixed C build error in doxygen refactoring. 2019-05-26 15:56:28 -04:00
Don Cross
5a19727dfe Hiding C code internals from Doxygen.
Certain macros and typedefs were ending up in Doxygen output
that have no reason to be documented for outside users.
Mostly I used Doxygen conditionals to hide them.
In a couple of cases I had some internal functions that needed
to be declared static so Doxygen hides them.

Added DoxygenLayout.xml, but not using it yet.
Still trying to figure out how to make Markdown output
that doesn't look terrible. Not sure I can get Moxygen
to do what I want. I may have to create my own simple(?) tool.
2019-05-26 15:49:37 -04:00
Don Cross
59dcc75625 Adding more C documentation. 2019-05-26 14:52:08 -04:00
Don Cross
7591cd26ef Starting to add more C documentation. Still working on doxygen/moxygen. 2019-05-26 12:05:55 -04:00
Don Cross
f4c3a867da Starting to generate C documentation in Markdown format. 2019-05-26 11:36:38 -04:00
Don Cross
c5ee9b6830 Starting to get doxygen to work. 2019-05-26 10:09:09 -04:00
Don Cross
6a96c520dd Original generated Doxyfile. 2019-05-26 09:21:18 -04:00
Don Cross
9ed995e462 Added C function Astronomy_CurrentTime(). Added C moon phase demo. 2019-05-25 21:18:24 -04:00
Don Cross
96b3b8a9f0 Added C functions UtcFromTime, TimeFromUtc.
These functions allow generating a Gregorian calendar date and time
in UTC from an astro_time_t, and vice versa.
This filled in a gap where we needed a way to transform an astronomy
time value into something a user would recognize.

I may have to revisit this later for compatibility with the <time.h>
standard library, etc.
2019-05-25 15:31:45 -04:00
Don Cross
821e89e10b Validated C functions SearchLunarApsis, NextLunarApsis. 2019-05-24 19:29:31 -04:00
Don Cross
ba7814df4d Added protection from infinite loops in JS, C versions of SearchLunarApsis.
I made sure it is not possible to get stuck in an infinite
loop inside SearchLunarApsis, both the C and JavaScript versions.
If we loop over more time than 2 synodic months (more than enough time),
bail out with an exception (JS) or an internal error (C).
2019-05-24 17:21:04 -04:00
Don Cross
74dd133391 Implemented C function SearchLunarApsis, but not yet tested. 2019-05-24 16:58:03 -04:00
Don Cross
8cca72c959 Validated C function SearchPeakMagnitude. 2019-05-24 15:41:51 -04:00
Don Cross
6d6e161b53 Implemented C test for Saturn magnitude. Fixed bug in Astronomy_Ecliptic.
Astronomy_Ecliptic was using midnight on 2000-01-01 as the epoch,
but it should have been using noon. Fixed it. Discovered because
there was a tiny but larger than expected error in calculating
the tilt of Saturn's rings.
2019-05-23 21:47:15 -04:00