@@ -54,12 +54,12 @@ cl::opt<bool> allowHugoSpecificFeatures(
5454 cl::cat(docCat));
5555
5656void mlir::tblgen::emitSummary (StringRef summary, raw_ostream &os) {
57- if (! summary.empty ()) {
58- StringRef trimmed = summary. trim () ;
59- char first = std::toupper (trimmed. front () );
60- StringRef rest = trimmed.drop_front ( );
61- os << " \n _ " << first << rest << " _ \n\n "
62- }
57+ if (summary.empty ())
58+ return ;
59+ StringRef trimmed = summary. trim ( );
60+ char first = std::toupper ( trimmed.front () );
61+ StringRef rest = trimmed. drop_front () ;
62+ os << " \n _ " << first << rest << " _ \n " ;
6363}
6464
6565// Emit the description by aligning the text to the left per line (e.g.,
@@ -69,6 +69,9 @@ void mlir::tblgen::emitSummary(StringRef summary, raw_ostream &os) {
6969// in a way the user wanted but has some additional indenting due to being
7070// nested in the op definition.
7171void mlir::tblgen::emitDescription (StringRef description, raw_ostream &os) {
72+ if (description.empty ())
73+ return ;
74+ os << " \n "
7275 raw_indented_ostream ros (os);
7376 StringRef trimmed = description.rtrim (" \t "
7477 ros.printReindented (trimmed);
@@ -80,29 +83,22 @@ void mlir::tblgen::emitDescriptionComment(StringRef description,
8083 raw_ostream &os, StringRef prefix) {
8184 if (description.empty ())
8285 return ;
86+ os << " \n "
8387 raw_indented_ostream ros (os);
8488 StringRef trimmed = description.rtrim (" \t "
8589 ros.printReindented (trimmed, (Twine (prefix) + " /// " str ());
8690 if (!trimmed.ends_with (" \n "
8791 ros << " \n "
8892}
8993
90- // Emits `str` with trailing newline if not empty.
91- static void emitIfNotEmpty (StringRef str, raw_ostream &os) {
92- if (!str.empty ()) {
93- emitDescription (str, os);
94- os << " \n "
95- }
96- }
97-
9894// / Emit the given named constraint.
9995template <typename T>
10096static void emitNamedConstraint (const T &it, raw_ostream &os) {
10197 if (!it.name .empty ())
10298 os << " | `" name << " `"
10399 else
104- os << " «unnamed»"
105- os << " | " constraint .getSummary () << " \n "
100+ os << " | «unnamed»"
101+ os << " | " constraint .getSummary () << " | \n "
106102}
107103
108104// ===----------------------------------------------------------------------===//
@@ -112,6 +108,8 @@ static void emitNamedConstraint(const T &it, raw_ostream &os) {
112108// / Emit the assembly format of an operation.
113109static void emitAssemblyFormat (StringRef opName, StringRef format,
114110 raw_ostream &os) {
111+ if (format.empty ())
112+ return ;
115113 os << " \n Syntax:\n\n ```\n operation ::= `" " ` "
116114
117115 // Print the assembly format aligned.
@@ -124,7 +122,7 @@ static void emitAssemblyFormat(StringRef opName, StringRef format,
124122 if (!formatChunk.empty ())
125123 os.indent (indent) << formatChunk << " \n "
126124 } while (!split.second .empty ());
127- os << " ```\n\n "
125+ os << " ```\n "
128126}
129127
130128// / Place `text` between backticks so that the Markdown processor renders it as
@@ -199,7 +197,7 @@ static void emitOpDoc(const Operator &op, raw_ostream &os) {
199197 std::string classNameStr = op.getQualCppClassName ();
200198 StringRef className = classNameStr;
201199 (void )className.consume_front (stripPrefix);
202- os << formatv (" ### `{0}` ({1})\n " getOperationName (), className);
200+ os << formatv (" \n ### `{0}` ({1})\n " getOperationName (), className);
203201
204202 // Emit the summary, syntax, and description if present.
205203 if (op.hasSummary ())
@@ -281,8 +279,8 @@ static void emitSourceLink(StringRef inputFilename, raw_ostream &os) {
281279
282280 StringRef inputFromMlirInclude = inputFilename.substr (pathBegin);
283281
284- os << " [source](https://github.com/llvm/llvm-project/blob/main/"
285- << inputFromMlirInclude << " )\n\n "
282+ os << " \n [source](https://github.com/llvm/llvm-project/blob/main/"
283+ << inputFromMlirInclude << " )\n "
286284}
287285
288286static void emitOpDoc (const RecordKeeper &records, raw_ostream &os) {
@@ -299,19 +297,19 @@ static void emitOpDoc(const RecordKeeper &records, raw_ostream &os) {
299297// ===----------------------------------------------------------------------===//
300298
301299static void emitAttrDoc (const Attribute &attr, raw_ostream &os) {
302- os << " ### " getSummary () << " \n \n"
300+ os << " \n ### " getSummary () << " \n "
303301 emitDescription (attr.getDescription (), os);
304- os << " \n\n "
302+ os << " \n "
305303}
306304
307305// ===----------------------------------------------------------------------===//
308306// Type Documentation
309307// ===----------------------------------------------------------------------===//
310308
311309static void emitTypeDoc (const Type &type, raw_ostream &os) {
312- os << " ### " getSummary () << " \n \n"
310+ os << " \n ### " getSummary () << " \n "
313311 emitDescription (type.getDescription (), os);
314- os << " \n\n "
312+ os << " \n "
315313}
316314
317315// ===----------------------------------------------------------------------===//
@@ -342,19 +340,18 @@ static void emitAttrOrTypeDefAssemblyFormat(const AttrOrTypeDef &def,
342340}
343341
344342static void emitAttrOrTypeDefDoc (const AttrOrTypeDef &def, raw_ostream &os) {
345- os << formatv (" ### {0}\n " getCppClassName ());
343+ os << formatv (" \n ### {0}\n " getCppClassName ());
346344
347345 // Emit the summary if present.
348346 if (def.hasSummary ())
349- os << " \n " << def.getSummary () << " \n "
347+ emitSummary ( def.getSummary (), os) ;
350348
351349 // Emit the syntax if present.
352350 if (def.getMnemonic () && !def.hasCustomAssemblyFormat ())
353351 emitAttrOrTypeDefAssemblyFormat (def, os);
354352
355353 // Emit the description if present.
356354 if (def.hasDescription ()) {
357- os << " \n "
358355 mlir::tblgen::emitDescription (def.getDescription (), os);
359356 }
360357
@@ -363,11 +360,11 @@ static void emitAttrOrTypeDefDoc(const AttrOrTypeDef &def, raw_ostream &os) {
363360 if (!parameters.empty ()) {
364361 os << " \n #### Parameters:\n\n "
365362 os << " | Parameter | C++ type | Description |\n "
366- << " | :-------: | :-------: | ----------- |\n "
363+ << " | :-------: | :-------: | ----------- |"
367364 for (const auto &it : parameters) {
368365 auto desc = it.getSummary ();
369- os << " | " getName () << " | `" getCppType () << " ` | "
370- << (desc ? *desc : " " " |\n "
366+ os << " \n | " getName () << " | `" getCppType () << " ` | "
367+ << (desc ? *desc : " " " |"
371368 }
372369 }
373370
@@ -388,20 +385,19 @@ static void emitAttrOrTypeDefDoc(const RecordKeeper &records, raw_ostream &os,
388385// ===----------------------------------------------------------------------===//
389386
390387static void emitEnumDoc (const EnumAttr &def, raw_ostream &os) {
391- os << formatv (" ### {0}\n " getEnumClassName ());
388+ os << formatv (" \n ### {0}\n " getEnumClassName ());
392389
393390 // Emit the summary if present.
394- if (!def.getSummary ().empty ())
395- os << " \n " getSummary () << " \n "
391+ emitSummary (def.getSummary (), os);
396392
397393 // Emit case documentation.
398394 std::vector<EnumAttrCase> cases = def.getAllCases ();
399395 os << " \n #### Cases:\n\n "
400396 os << " | Symbol | Value | String |\n "
401- << " | :----: | :---: | ------ |\n "
397+ << " | :----: | :---: | ------ |"
402398 for (const auto &it : cases) {
403- os << " | " getSymbol () << " | `" getValue () << " ` | "
404- << it.getStr () << " |\n "
399+ os << " \n | " getSymbol () << " | `" getValue () << " ` | "
400+ << it.getStr () << " |"
405401 }
406402
407403 os << " \n "
@@ -447,17 +443,17 @@ static void emitBlock(ArrayRef<Attribute> attributes, StringRef inputFilename,
447443 ArrayRef<Type> types, ArrayRef<TypeDef> typeDefs,
448444 ArrayRef<EnumAttr> enums, raw_ostream &os) {
449445 if (!ops.empty ()) {
450- os << " ## Operations\n \n"
446+ os << " \n ## Operations\n "
451447 emitSourceLink (inputFilename, os);
452448 for (const OpDocGroup &grouping : ops) {
453449 bool nested = !grouping.summary .empty ();
454450 maybeNest (
455451 nested,
456452 [&](raw_ostream &os) {
457453 if (nested) {
458- os << " ## " StringRef (grouping.summary ).trim () << " \n \n"
454+ os << " \n ## " StringRef (grouping.summary ).trim () << " \n "
459455 emitDescription (grouping.description , os);
460- os << " \n\n "
456+ os << " \n "
461457 }
462458 for (const Operator &op : grouping.ops ) {
463459 emitOpDoc (op, os);
@@ -468,32 +464,32 @@ static void emitBlock(ArrayRef<Attribute> attributes, StringRef inputFilename,
468464 }
469465
470466 if (!attributes.empty ()) {
471- os << " ## Attribute constraints\n \n"
467+ os << " \n ## Attribute constraints\n "
472468 for (const Attribute &attr : attributes)
473469 emitAttrDoc (attr, os);
474470 }
475471
476472 if (!attrDefs.empty ()) {
477- os << " ## Attributes\n \n"
473+ os << " \n ## Attributes\n "
478474 for (const AttrDef &def : attrDefs)
479475 emitAttrOrTypeDefDoc (def, os);
480476 }
481477
482478 // TODO: Add link between use and def for types
483479 if (!types.empty ()) {
484- os << " ## Type constraints\n \n"
480+ os << " \n ## Type constraints\n "
485481 for (const Type &type : types)
486482 emitTypeDoc (type, os);
487483 }
488484
489485 if (!typeDefs.empty ()) {
490- os << " ## Types\n \n"
486+ os << " \n ## Types\n "
491487 for (const TypeDef &def : typeDefs)
492488 emitAttrOrTypeDefDoc (def, os);
493489 }
494490
495491 if (!enums.empty ()) {
496- os << " ## Enums\n \n"
492+ os << " \n ## Enums\n "
497493 for (const EnumAttr &def : enums)
498494 emitEnumDoc (def, os);
499495 }
@@ -504,14 +500,14 @@ static void emitDialectDoc(const Dialect &dialect, StringRef inputFilename,
504500 ArrayRef<AttrDef> attrDefs, ArrayRef<OpDocGroup> ops,
505501 ArrayRef<Type> types, ArrayRef<TypeDef> typeDefs,
506502 ArrayRef<EnumAttr> enums, raw_ostream &os) {
507- os << " # '" getName () << " ' Dialect\n \n"
508- emitIfNotEmpty (dialect.getSummary (), os);
509- emitIfNotEmpty (dialect.getDescription (), os);
503+ os << " \n # '" getName () << " ' Dialect\n "
504+ emitSummary (dialect.getSummary (), os);
505+ emitDescription (dialect.getDescription (), os);
510506
511507 // Generate a TOC marker except if description already contains one.
512508 Regex r (" ^[[:space:]]*\\ [TOC\\ ]$"
513509 if (!r.match (dialect.getDescription ()))
514- os << " [TOC]\n \n"
510+ os << " \n [TOC]\n "
515511
516512 emitBlock (attributes, inputFilename, attrDefs, ops, types, typeDefs, enums,
517513 os);
0 commit comments