Skip to content

Commit 6600fe7

Browse files
vinniefalcovinniefalco
committed
chore: refactor Javadoc
1 parent 9dcc342 commit 6600fe7

13 files changed

+499
-492
lines changed

‎include/mrdox/Metadata/Javadoc.hpp

+258-251
Large diffs are not rendered by default.

‎source/-XML/XMLTags.cpp

+5-5
Original file line numberDiff line numberDiff line change
@@ -80,16 +80,16 @@ toString(
8080

8181
llvm::StringRef
8282
toString(
83-
Javadoc::Style style) noexcept
83+
doc::Style style) noexcept
8484
{
8585
switch(style)
8686
{
87-
case Javadoc::Style::bold: return "bold";
88-
case Javadoc::Style::mono: return "mono";
89-
case Javadoc::Style::italic: return "italic";
87+
case doc::Style::bold: return "bold";
88+
case doc::Style::mono: return "mono";
89+
case doc::Style::italic: return "italic";
9090

9191
// should never get here
92-
case Javadoc::Style::none: return "";
92+
case doc::Style::none: return "";
9393

9494
default:
9595
// unknown style

‎source/-XML/XMLTags.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ struct xmlEscape
6565
// Converters for attributes
6666
std::string toString(SymbolID const& id);
6767
llvm::StringRef toString(InfoKind) noexcept;
68-
llvm::StringRef toString(Javadoc::Style style) noexcept;
68+
llvm::StringRef toString(doc::Style style) noexcept;
6969

7070
//------------------------------------------------
7171

‎source/-XML/XMLWriter.cpp

+36-36
Original file line numberDiff line numberDiff line change
@@ -597,36 +597,36 @@ writeNodes(
597597
void
598598
XMLWriter::
599599
writeNode(
600-
Javadoc::Node const& node)
600+
doc::Node const& node)
601601
{
602602
switch(node.kind)
603603
{
604-
case Javadoc::Kind::text:
605-
writeText(static_cast<Javadoc::Text const&>(node));
604+
case doc::Kind::text:
605+
writeText(static_cast<doc::Text const&>(node));
606606
break;
607-
case Javadoc::Kind::styled:
608-
writeStyledText(static_cast<Javadoc::StyledText const&>(node));
607+
case doc::Kind::styled:
608+
writeStyledText(static_cast<doc::StyledText const&>(node));
609609
break;
610-
case Javadoc::Kind::paragraph:
611-
writeParagraph(static_cast<Javadoc::Paragraph const&>(node));
610+
case doc::Kind::paragraph:
611+
writeParagraph(static_cast<doc::Paragraph const&>(node));
612612
break;
613-
case Javadoc::Kind::brief:
614-
writeBrief(static_cast<Javadoc::Brief const&>(node));
613+
case doc::Kind::brief:
614+
writeBrief(static_cast<doc::Brief const&>(node));
615615
break;
616-
case Javadoc::Kind::admonition:
617-
writeAdmonition(static_cast<Javadoc::Admonition const&>(node));
616+
case doc::Kind::admonition:
617+
writeAdmonition(static_cast<doc::Admonition const&>(node));
618618
break;
619-
case Javadoc::Kind::code:
620-
writeCode(static_cast<Javadoc::Code const&>(node));
619+
case doc::Kind::code:
620+
writeCode(static_cast<doc::Code const&>(node));
621621
break;
622-
case Javadoc::Kind::param:
623-
writeJParam(static_cast<Javadoc::Param const&>(node));
622+
case doc::Kind::param:
623+
writeJParam(static_cast<doc::Param const&>(node));
624624
break;
625-
case Javadoc::Kind::tparam:
626-
writeTParam(static_cast<Javadoc::TParam const&>(node));
625+
case doc::Kind::tparam:
626+
writeTParam(static_cast<doc::TParam const&>(node));
627627
break;
628-
case Javadoc::Kind::returns:
629-
writeReturns(static_cast<Javadoc::Returns const&>(node));
628+
case doc::Kind::returns:
629+
writeReturns(static_cast<doc::Returns const&>(node));
630630
break;
631631
default:
632632
// unknown kind
@@ -637,7 +637,7 @@ writeNode(
637637
void
638638
XMLWriter::
639639
writeBrief(
640-
Javadoc::Paragraph const& node)
640+
doc::Paragraph const& node)
641641
{
642642
tags_.open("brief");
643643
writeNodes(node.children);
@@ -647,7 +647,7 @@ writeBrief(
647647
void
648648
XMLWriter::
649649
writeText(
650-
Javadoc::Text const& node)
650+
doc::Text const& node)
651651
{
652652
tags_.indent() <<
653653
"<text>" <<
@@ -658,15 +658,15 @@ writeText(
658658
void
659659
XMLWriter::
660660
writeStyledText(
661-
Javadoc::StyledText const& node)
661+
doc::StyledText const& node)
662662
{
663663
tags_.write(toString(node.style), node.string);
664664
}
665665

666666
void
667667
XMLWriter::
668668
writeParagraph(
669-
Javadoc::Paragraph const& para,
669+
doc::Paragraph const& para,
670670
llvm::StringRef tag)
671671
{
672672
tags_.open("para", {
@@ -678,24 +678,24 @@ writeParagraph(
678678
void
679679
XMLWriter::
680680
writeAdmonition(
681-
Javadoc::Admonition const& admonition)
681+
doc::Admonition const& admonition)
682682
{
683683
llvm::StringRef tag;
684684
switch(admonition.style)
685685
{
686-
case Javadoc::Admonish::note:
686+
case doc::Admonish::note:
687687
tag = "note";
688688
break;
689-
case Javadoc::Admonish::tip:
689+
case doc::Admonish::tip:
690690
tag = "tip";
691691
break;
692-
case Javadoc::Admonish::important:
692+
case doc::Admonish::important:
693693
tag = "important";
694694
break;
695-
case Javadoc::Admonish::caution:
695+
case doc::Admonish::caution:
696696
tag = "caution";
697697
break;
698-
case Javadoc::Admonish::warning:
698+
case doc::Admonish::warning:
699699
tag = "warning";
700700
break;
701701
default:
@@ -707,7 +707,7 @@ writeAdmonition(
707707

708708
void
709709
XMLWriter::
710-
writeCode(Javadoc::Code const& code)
710+
writeCode(doc::Code const& code)
711711
{
712712
if(code.children.empty())
713713
{
@@ -723,7 +723,7 @@ writeCode(Javadoc::Code const& code)
723723
void
724724
XMLWriter::
725725
writeReturns(
726-
Javadoc::Returns const& returns)
726+
doc::Returns const& returns)
727727
{
728728
if(returns.empty())
729729
return;
@@ -735,18 +735,18 @@ writeReturns(
735735
void
736736
XMLWriter::
737737
writeJParam(
738-
Javadoc::Param const& param)
738+
doc::Param const& param)
739739
{
740740
const char* direction = nullptr;
741741
switch(param.direction)
742742
{
743-
case Javadoc::ParamDirection::in:
743+
case doc::ParamDirection::in:
744744
direction = "in";
745745
break;
746-
case Javadoc::ParamDirection::out:
746+
case doc::ParamDirection::out:
747747
direction = "out";
748748
break;
749-
case Javadoc::ParamDirection::inout:
749+
case doc::ParamDirection::inout:
750750
direction = "inout";
751751
break;
752752
default:
@@ -763,7 +763,7 @@ writeJParam(
763763
void
764764
XMLWriter::
765765
writeTParam(
766-
Javadoc::TParam const& tparam)
766+
doc::TParam const& tparam)
767767
{
768768
tags_.open("tparam", {
769769
{ "name", tparam.name, ! tparam.name.empty() }});

‎source/-XML/XMLWriter.hpp

+10-10
Original file line numberDiff line numberDiff line change
@@ -83,16 +83,16 @@ class XMLWriter
8383

8484
template<class T>
8585
void writeNodes(AnyList<T> const& list);
86-
void writeNode(Javadoc::Node const& node);
87-
void writeBrief(Javadoc::Paragraph const& node);
88-
void writeText(Javadoc::Text const& node);
89-
void writeStyledText(Javadoc::StyledText const& node);
90-
void writeParagraph(Javadoc::Paragraph const& node, llvm::StringRef tag = "");
91-
void writeAdmonition(Javadoc::Admonition const& node);
92-
void writeCode(Javadoc::Code const& node);
93-
void writeReturns(Javadoc::Returns const& node);
94-
void writeJParam(Javadoc::Param const& node);
95-
void writeTParam(Javadoc::TParam const& node);
86+
void writeNode(doc::Node const& node);
87+
void writeBrief(doc::Paragraph const& node);
88+
void writeText(doc::Text const& node);
89+
void writeStyledText(doc::StyledText const& node);
90+
void writeParagraph(doc::Paragraph const& node, llvm::StringRef tag = "");
91+
void writeAdmonition(doc::Admonition const& node);
92+
void writeCode(doc::Code const& node);
93+
void writeReturns(doc::Returns const& node);
94+
void writeJParam(doc::Param const& node);
95+
void writeTParam(doc::TParam const& node);
9696
};
9797

9898
} // xml

‎source/-adoc/AdocWriter.cpp

+34-34
Original file line numberDiff line numberDiff line change
@@ -624,39 +624,39 @@ writeFunctionDeclaration(
624624
void
625625
AdocWriter::
626626
writeNode(
627-
Javadoc::Node const& node)
627+
doc::Node const& node)
628628
{
629629
switch(node.kind)
630630
{
631-
case Javadoc::Kind::text:
632-
writeNode(static_cast<Javadoc::Text const&>(node));
631+
case doc::Kind::text:
632+
writeNode(static_cast<doc::Text const&>(node));
633633
return;
634-
case Javadoc::Kind::styled:
635-
writeNode(static_cast<Javadoc::StyledText const&>(node));
634+
case doc::Kind::styled:
635+
writeNode(static_cast<doc::StyledText const&>(node));
636636
return;
637637
#if 0
638-
case Javadoc::Node::block:
639-
writeNode(static_cast<Javadoc::Block const&>(node));
638+
case doc::Node::block:
639+
writeNode(static_cast<doc::Block const&>(node));
640640
return;
641641
#endif
642-
case Javadoc::Kind::brief:
643-
case Javadoc::Kind::paragraph:
644-
writeNode(static_cast<Javadoc::Paragraph const&>(node));
642+
case doc::Kind::brief:
643+
case doc::Kind::paragraph:
644+
writeNode(static_cast<doc::Paragraph const&>(node));
645645
return;
646-
case Javadoc::Kind::admonition:
647-
writeNode(static_cast<Javadoc::Admonition const&>(node));
646+
case doc::Kind::admonition:
647+
writeNode(static_cast<doc::Admonition const&>(node));
648648
return;
649-
case Javadoc::Kind::code:
650-
writeNode(static_cast<Javadoc::Code const&>(node));
649+
case doc::Kind::code:
650+
writeNode(static_cast<doc::Code const&>(node));
651651
return;
652-
case Javadoc::Kind::param:
653-
writeNode(static_cast<Javadoc::Param const&>(node));
652+
case doc::Kind::param:
653+
writeNode(static_cast<doc::Param const&>(node));
654654
return;
655-
case Javadoc::Kind::tparam:
656-
writeNode(static_cast<Javadoc::TParam const&>(node));
655+
case doc::Kind::tparam:
656+
writeNode(static_cast<doc::TParam const&>(node));
657657
return;
658-
case Javadoc::Kind::returns:
659-
writeNode(static_cast<Javadoc::Returns const&>(node));
658+
case doc::Kind::returns:
659+
writeNode(static_cast<doc::Returns const&>(node));
660660
return;
661661
default:
662662
// unknown kind
@@ -667,7 +667,7 @@ writeNode(
667667
void
668668
AdocWriter::
669669
writeNode(
670-
Javadoc::Block const&)
670+
doc::Block const&)
671671
{
672672
// shouldn't get here
673673
MRDOX_ASSERT(false);
@@ -676,27 +676,27 @@ writeNode(
676676
void
677677
AdocWriter::
678678
writeNode(
679-
Javadoc::Text const& node)
679+
doc::Text const& node)
680680
{
681-
// Text nodes must be left aligned or
681+
// doc::Text nodes must be left aligned or
682682
// else they can be rendered up as code.
683683
os_ << llvm::StringRef(node.string).ltrim() << '\n';
684684
}
685685

686686
void
687687
AdocWriter::
688688
writeNode(
689-
Javadoc::StyledText const& node)
689+
doc::StyledText const& node)
690690
{
691691
switch(node.style)
692692
{
693-
case Javadoc::Style::bold:
693+
case doc::Style::bold:
694694
os_ << '*' << node.string << "*\n";
695695
break;
696-
case Javadoc::Style::mono:
696+
case doc::Style::mono:
697697
os_ << '`' << node.string << "`\n";
698698
break;
699-
case Javadoc::Style::italic:
699+
case doc::Style::italic:
700700
os_ << '_' << node.string << "_\n";
701701
break;
702702
default:
@@ -708,28 +708,28 @@ writeNode(
708708
void
709709
AdocWriter::
710710
writeNode(
711-
Javadoc::Paragraph const& node)
711+
doc::Paragraph const& node)
712712
{
713713
writeNodes(node.children);
714714
}
715715

716716
void
717717
AdocWriter::
718718
writeNode(
719-
Javadoc::Admonition const& node)
719+
doc::Admonition const& node)
720720
{
721721
writeNodes(node.children);
722722
}
723723

724724
void
725725
AdocWriter::
726726
writeNode(
727-
Javadoc::Code const& node)
727+
doc::Code const& node)
728728
{
729729
os_ <<
730730
"[,cpp]\n"
731731
"----\n";
732-
AnyList<Javadoc::Text> const& list(node.children);
732+
AnyList<doc::Text> const& list(node.children);
733733
if(! list.empty())
734734
{
735735
// measure the left margin
@@ -756,21 +756,21 @@ writeNode(
756756
void
757757
AdocWriter::
758758
writeNode(
759-
Javadoc::Param const& node)
759+
doc::Param const& node)
760760
{
761761
}
762762

763763
void
764764
AdocWriter::
765765
writeNode(
766-
Javadoc::TParam const& node)
766+
doc::TParam const& node)
767767
{
768768
}
769769

770770
void
771771
AdocWriter::
772772
writeNode(
773-
Javadoc::Returns const& node)
773+
doc::Returns const& node)
774774
{
775775
}
776776

0 commit comments

Comments
 (0)