Skip to content

Conversation

@niess
Copy link
Contributor

@niess niess commented Mar 23, 2016

  • Running 0.4.2 on Ubuntu 14.04 LTS I got encoding errors with html codes, e.g. α. I didn't manage to escape those by changing my settings. However, forcing the encoding to utf8 in docorium.rb, as discussed here solved the problem.
  • Functions returning an enum were not reported in the Returned by field of the corresponding enum page, because exact matching was not allowed. The corresponding regexp was changed.
  • A callback entry has been added as a submenu of Types, in the sidebar. Furthermore if a menu or submenu is empty it is no more reported on the sidebar.
  • In addition to functions, callbacks are also reported as Argument in or Returned by for enums and structs.
  • The Returned by and Argument in items are comma separated to ease reading.
  • This is a nice tool :) Exactly what I was looking for for my current project: lighter than Doxygen, C+git dedicated.

niess added 6 commits March 18, 2016 22:41
This prevents a crash when symbols, e.g. α are encoded using .to_json.
Callbacks as well as functions are now shown in the stats of a structure usage.
Callbacks appear in the `Types` menu. In addition if a type is missing, e.g. opaques structures, the corresponding sub-menu doesnt appear anymore.
Also link doesn't show the current function anymore.
Added commas separator and dot for the list of links to Argument in/returned by, in structures.
Exact matching of `returned by/argument in` is now allowed.
@carlosmn
Copy link
Member

Thanks. I'm not sure about the 'callbacks' name for function pointers, since they're not always callbacks as such, but you might be providing an interface in a struct. But I'll merge as-is and then I'll see if I feel strongly enough to change it.

@carlosmn carlosmn merged commit 0574a3d into libgit2:master Mar 30, 2016
@niess
Copy link
Contributor Author

niess commented Mar 30, 2016

Hello :) One could flag function pointers as callbacks only if the end with _cb, _cb_t. Though it would enforce some coding convention :(

@niess niess deleted the master branch March 30, 2016 20:31
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.

2 participants