Page MenuHomePhabricator

[clang-doc] Redesign of generated HTML files
ClosedPublic

Authored by DiegoAstiazaran on Aug 16 2019, 9:20 AM.

Details

Summary

The new design includes a header (contains the project name), a main section, and a footer.
The main section is divided into three subsections. Left, middle, right. The left section contains the general index, the middle contains the info's data, and the right contains the index for the info's content.
The CSS has been updated.
A flag --project-name is added.
The Attributes attribute of the TagNode struct is now a vector of pairs because these attributes should be rendered in the insertion order.
The functions (cpp and js) that converts an Index tree structure into HTML were slightly modified; the first ul tag created is now a ol tag. The inner lists are still ul.

Diff Detail

Repository
rL LLVM

Event Timeline

Update clang-doc documentation.

DiegoAstiazaran added a project: Restricted Project.
DiegoAstiazaran added a subscriber: cfe-commits.

Run clang-format

juliehockett added inline comments.Aug 16 2019, 10:09 AM
clang-tools-extra/clang-doc/HTMLGenerator.cpp
487–489 ↗(On Diff #215624)

Would you be able to briefly comment on each of these gen*Node functions on what exactly they're doing? I'm having trouble getting a picture of what the flow is there

523 ↗(On Diff #215624)
828 ↗(On Diff #215624)

This isn't doing anything

DiegoAstiazaran marked 3 inline comments as done.

Add comments.
Fix clang-doc version.

DiegoAstiazaran edited the summary of this revision. (Show Details)Aug 16 2019, 11:20 AM
This revision is now accepted and ready to land.Aug 16 2019, 11:33 AM
This revision was automatically updated to reflect the committed changes.
Herald added a project: Restricted Project. · View Herald TranscriptAug 16 2019, 11:40 AM