This is an archive of the discontinued LLVM Phabricator instance.

[Headers][X86] Replace \operation with \code{.operation}
ClosedPublic

Authored by RKSimon on May 7 2022, 8:56 AM.

Details

Summary

\operation ... \endoperation are not valid doxygen commands and cause issues when -Wdocumentation is enabled (Issue #35297)

This patch proposes to replace them with \code{.operation} ... \endcode blocks so that the pseudo-code is correctly retained in any documentation

Diff Detail

Event Timeline

RKSimon created this revision.May 7 2022, 8:56 AM
Herald added a project: Restricted Project. · View Herald TranscriptMay 7 2022, 8:56 AM
Herald added a subscriber: StephenFan. · View Herald Transcript
RKSimon requested review of this revision.May 7 2022, 8:56 AM
Herald added a project: Restricted Project. · View Herald TranscriptMay 7 2022, 8:56 AM

If people prefer we can alternatively use \code{.unparsed} .. \endcode blocks - I'm unsure if these operation blocks are being used in a particular way downstream

If people prefer we can alternatively use \code{.unparsed} .. \endcode blocks - I'm unsure if these operation blocks are being used in a particular way downstream

We have used \code .. \endcode blocks in headers, so maybe \code{.operation} .. \endcode for precisely match? We haven't used verbatim before, but I'm a little concerned we may mix up in future.

RKSimon updated this revision to Diff 427913.May 8 2022, 1:46 AM
RKSimon edited the summary of this revision. (Show Details)

Use \code{.operation} ... \endcode

RKSimon retitled this revision from [Headers][X86] Replace \operation with \verbatim to [Headers][X86] Replace \operation with \code{.operation}.May 8 2022, 1:46 AM
pengfei accepted this revision.May 8 2022, 2:22 AM

LGTM, thanks!

This revision is now accepted and ready to land.May 8 2022, 2:22 AM
This revision was landed with ongoing or failed builds.May 8 2022, 2:47 AM
This revision was automatically updated to reflect the committed changes.