Skip to content

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

Merged

Conversation

akosthekiss
Copy link
Member

  • 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]

@akosthekiss
Copy link
Member Author

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.

@akosthekiss akosthekiss added enhancement An improvement documentation Related to documentation labels Feb 16, 2016
@akosthekiss akosthekiss force-pushed the doxygen-layout-change branch from 575a499 to ae13b7b Compare February 17, 2016 01:29
@LaszloLango
Copy link
Contributor

I think the improvement of the content is more important than the improvement of the style. :)

@akosthekiss
Copy link
Member Author

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?

@LaszloLango
Copy link
Contributor

@akiss77, how can I check the difference between this PR and the current style? How can I generate the doxygen documentation?

@akosthekiss
Copy link
Member Author

Type doxygen in the root directory of the project and check the results indocs/doxygen/html.

@LaszloLango
Copy link
Contributor

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?
Current style in doxygen

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)

@akosthekiss
Copy link
Member Author

@LaszloLango I've digged in the sources of doxygen and found it hard-coded in the htmlgen where that closing ) is written. It only goes to the same line if the function has 0 or 1 arg.

@LaszloLango
Copy link
Contributor

@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]
@akosthekiss akosthekiss force-pushed the doxygen-layout-change branch from ae13b7b to 6107f35 Compare February 18, 2016 15:23
@galpeter
Copy link
Contributor

LGTM :)

@akosthekiss akosthekiss merged commit 6107f35 into jerryscript-project:master Feb 18, 2016
@akosthekiss akosthekiss deleted the doxygen-layout-change branch February 18, 2016 16:04
@zherczeg
Copy link
Member

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to documentation enhancement An improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants