cppalliance / mrdocs

MrDocs: A Clang/LLVM tool for building reference documentation from C++ code and javadoc comments.
https://mrdocs.com
Other
75 stars 16 forks source link

Implements using directives, using declarations and namespace aliases #545

Closed fpelliccioni closed 5 months ago

fpelliccioni commented 5 months ago

Add support for these new Info kinds to the adoc templates, and this should be good to go.

@sdkrystian This was already done a long time ago, here is the link to the file:

https://github.com/cppalliance/mrdocs/blob/374c13c7ece462806d8ee8eda65827c25d9557b5/share/mrdocs/addons/generator/asciidoc/partials/tranche.adoc.hbs

Or do you mean something else?

sdkrystian commented 5 months ago

The XML schema needs to be updated.

With respect to updating the asciidoc templates, you need to add handlebars partials for rendering the documentation page of an alias and using here, and also add handlebars partials for rendering the signature of such symbols here (the signature of a using declaration would e.g. be using A::f)

sdkrystian commented 5 months ago

@fpelliccioni Please try generating an asciidoc reference containing using declarations/using directives/namespace aliases. The asciidoc partials you wrote contain numerous errors, so it would be easier if you were able to see the output and adjust them accordingly :)

vinniefalco commented 5 months ago

Why has this been sitting in the PR queue for 5+ weeks?

fpelliccioni commented 5 months ago

Why has this been sitting in the PR queue for 5+ weeks?

The PR is quite comprehensive, touching on 63 files across different parts of the project. It took some time to ensure everything was aligned and functioning as expected. The good news is that the PR has now passed all CI checks and has been approved. I'm merging it as we speak. Really appreciate your patience and support!

fpelliccioni commented 5 months ago

Make sure tests pass in CI, otherwise LGTM

@sdkrystian I am not abled to merge it.

alandefreitas commented 4 months ago

This has been merged even though it broke CI

https://github.com/cppalliance/mrdocs/actions/runs/8819808424

See develop runs in:

https://github.com/cppalliance/mrdocs/actions?query=branch%3Adevelop

fpelliccioni commented 4 months ago

I will take a look at it

On Sat, May 11, 2024, 5:39 AM Alan de Freitas @.***> wrote:

This has been merged even though it broke CI

https://github.com/cppalliance/mrdocs/actions/runs/8819808424

— Reply to this email directly, view it on GitHub https://github.com/cppalliance/mrdocs/pull/545#issuecomment-2105518168, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACC2EYITLZSC53HKDRQTLDZBWHGTAVCNFSM6AAAAABEPJIICKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMBVGUYTQMJWHA . You are receiving this because you were mentioned.Message ID: @.***>