forked from OSchip/llvm-project
[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:
parent
03085156ec
commit
a88371490d
|
@ -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);
|
||||
|
||||
|
|
Loading…
Reference in New Issue