[mlir] better formatting in interface docs

Start the description from a new line instead of putting the first
paragraph in the section header. Wrap the class name in backticks to
make it clear that it relates to the code.
This commit is contained in:
Alex Zinenko 2021-03-15 11:10:32 +01:00
parent 03085156ec
commit a88371490d
1 changed files with 2 additions and 1 deletions

View File

@ -381,7 +381,8 @@ static void emitInterfaceDoc(const llvm::Record &interfaceDef,
Interface interface(&interfaceDef);
// Emit the interface name followed by the description.
os << "## " << interface.getName() << " (" << interfaceDef.getName() << ")";
os << "## " << interface.getName() << " (`" << interfaceDef.getName()
<< "`)\n\n";
if (auto description = interface.getDescription())
mlir::tblgen::emitDescription(*description, os);