-
Notifications
You must be signed in to change notification settings - Fork 684
Change the layout of the doxygen-generated documentation #890
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
Change the layout of the doxygen-generated documentation #890
Conversation
I admit that it is a very subjective matter what looks good. So, please take these as my personal preferences. Happy to drop this PR if others don't like this look. |
575a499
to
ae13b7b
Compare
I think the improvement of the content is more important than the improvement of the style. :) |
I agree, at least partially. My problem was that I couldn't grasp the content because of the style. But then, what now with this PR? Update & merge, close/drop, or just let it linger here for a while more? |
@akiss77, how can I check the difference between this PR and the current style? How can I generate the doxygen documentation? |
Type |
I'm Ok with the changes. You can land if you'd like to do. Just a "feature request". Is it possible to align the right parenthesis to the end of the last argumet? uint64_t __attr_const___ jrt_extract_bit_field (uint64_t container,
size_t lsb,
size_t width)
) What I'd like to see: uint64_t __attr_const___ jrt_extract_bit_field (uint64_t container,
size_t lsb,
size_t width) |
@LaszloLango I've digged in the sources of doxygen and found it hard-coded in the |
@akiss77, thanks for checking it. |
* Move from index-based layout to treeview-based one. * Automatically take the first sentence of the documentation as the brief doc. * Always generate both brief and detailed description sections, and always sort them alpabetically. * Disable the generation of huge and overly complex call and caller graphs. * Make the project title title-cased. JerryScript-DCO-1.0-Signed-off-by: Akos Kiss [email protected]
ae13b7b
to
6107f35
Compare
LGTM :) |
LGTM |
brief doc.
always sort them alpabetically.
graphs.
JerryScript-DCO-1.0-Signed-off-by: Akos Kiss [email protected]