Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

tiennou
Copy link
Contributor

@tiennou tiennou commented Nov 1, 2016

This is a collection of fixes + features I got while learning how it works.

9f038b0 is the main one. It fixes the rendering mess of bulleted structs comments.

b3a09b3 adds a cm doc --for=$version option so you're not forced to build all versions each time (which is nice 😉).

22b9c5c is a style change that makes struct members render like function parameters descriptions. It can be dropped. I was just looking at how the HTML worked.

@mewmew
Copy link

mewmew commented Mar 31, 2017

@tiennou Lovely with some quality of life improvements. Both of the first outlined issues, I've also encountered when taking docurium out for a spin.

9f038b0 is the main one. It fixes the rendering mess of bulleted structs comments.

b3a09b3 adds a cm doc --for=$version option so you're not forced to build all versions each time (which is nice 😉).

Any chance of having this reviewed and potentially merged?

@tiennou
Copy link
Contributor Author

tiennou commented Feb 20, 2018

Sorry, I've kept piling on for a few years 😉(the commit list above is unordered though).

Highlights are :

  • removed the parallelization stuff to make it easier on both my brain and my kernel's process list.
  • added some debugging infrastructure to help pinpointing failures/parse errors quickly (eg. without having to understand what's going on too much). Also, it will output the first compilation error it encounters when parsing, which usually makes for missing typedefs or comments block altogether.
  • reworked the parser's context by 1) not recreating all headers for each header parse (they're generated per version now) 2) preserving complete paths to fix include issues.
  • reworked the styling of structs.

@tiennou tiennou force-pushed the tweaks branch 4 times, most recently from 1cd8be3 to 9d88c29 Compare March 22, 2018 22:11
@tiennou
Copy link
Contributor Author

tiennou commented Mar 22, 2018

Rebased, I've restored the test suite as well, so tests are "green" all along (thanks git rebase -x rake).

@carlosmn Care to review sometime soon ? I'd really like the documentation cleanups in libgit2/libgit2#4530 to be upstreamed, and it's been open for a while now…

This was referenced Jun 18, 2019
@tiennou tiennou force-pushed the tweaks branch 2 times, most recently from 89733d0 to e9fbd67 Compare December 1, 2019 13:31
@tiennou tiennou mentioned this pull request Apr 6, 2020
@tiennou tiennou closed this Apr 6, 2020
@tiennou tiennou deleted the tweaks branch April 6, 2020 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants