Skip to content

Commit

Permalink
chore: refactor Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@vinniefalco
vinniefalco committed Jun 12, 2023
1 parent 9dcc342 commit 6600fe7
Show file tree
Hide file tree
Showing 13 changed files with 499 additions and 492 deletions.
509 changes: 258 additions & 251 deletions include/mrdox/Metadata/Javadoc.hpp
View file

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions source/-XML/XMLTags.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,16 +80,16 @@ toString(

llvm::StringRef
toString(
Javadoc::Style style) noexcept
doc::Style style) noexcept
{
switch(style)
{
case Javadoc::Style::bold: return "bold";
case Javadoc::Style::mono: return "mono";
case Javadoc::Style::italic: return "italic";
case doc::Style::bold: return "bold";
case doc::Style::mono: return "mono";
case doc::Style::italic: return "italic";

// should never get here
case Javadoc::Style::none: return "";
case doc::Style::none: return "";

default:
// unknown style
Expand Down
2 changes: 1 addition & 1 deletion source/-XML/XMLTags.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ struct xmlEscape
// Converters for attributes
std::string toString(SymbolID const& id);
llvm::StringRef toString(InfoKind) noexcept;
llvm::StringRef toString(Javadoc::Style style) noexcept;
llvm::StringRef toString(doc::Style style) noexcept;

//------------------------------------------------

Expand Down
72 changes: 36 additions & 36 deletions source/-XML/XMLWriter.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -597,36 +597,36 @@ writeNodes(
void
XMLWriter::
writeNode(
Javadoc::Node const& node)
doc::Node const& node)
{
switch(node.kind)
{
case Javadoc::Kind::text:
writeText(static_cast<Javadoc::Text const&>(node));
case doc::Kind::text:
writeText(static_cast<doc::Text const&>(node));
break;
case Javadoc::Kind::styled:
writeStyledText(static_cast<Javadoc::StyledText const&>(node));
case doc::Kind::styled:
writeStyledText(static_cast<doc::StyledText const&>(node));
break;
case Javadoc::Kind::paragraph:
writeParagraph(static_cast<Javadoc::Paragraph const&>(node));
case doc::Kind::paragraph:
writeParagraph(static_cast<doc::Paragraph const&>(node));
break;
case Javadoc::Kind::brief:
writeBrief(static_cast<Javadoc::Brief const&>(node));
case doc::Kind::brief:
writeBrief(static_cast<doc::Brief const&>(node));
break;
case Javadoc::Kind::admonition:
writeAdmonition(static_cast<Javadoc::Admonition const&>(node));
case doc::Kind::admonition:
writeAdmonition(static_cast<doc::Admonition const&>(node));
break;
case Javadoc::Kind::code:
writeCode(static_cast<Javadoc::Code const&>(node));
case doc::Kind::code:
writeCode(static_cast<doc::Code const&>(node));
break;
case Javadoc::Kind::param:
writeJParam(static_cast<Javadoc::Param const&>(node));
case doc::Kind::param:
writeJParam(static_cast<doc::Param const&>(node));
break;
case Javadoc::Kind::tparam:
writeTParam(static_cast<Javadoc::TParam const&>(node));
case doc::Kind::tparam:
writeTParam(static_cast<doc::TParam const&>(node));
break;
case Javadoc::Kind::returns:
writeReturns(static_cast<Javadoc::Returns const&>(node));
case doc::Kind::returns:
writeReturns(static_cast<doc::Returns const&>(node));
break;
default:
// unknown kind
Expand All @@ -637,7 +637,7 @@ writeNode(
void
XMLWriter::
writeBrief(
Javadoc::Paragraph const& node)
doc::Paragraph const& node)
{
tags_.open("brief");
writeNodes(node.children);
Expand All @@ -647,7 +647,7 @@ writeBrief(
void
XMLWriter::
writeText(
Javadoc::Text const& node)
doc::Text const& node)
{
tags_.indent() <<
"<text>" <<
Expand All @@ -658,15 +658,15 @@ writeText(
void
XMLWriter::
writeStyledText(
Javadoc::StyledText const& node)
doc::StyledText const& node)
{
tags_.write(toString(node.style), node.string);
}

void
XMLWriter::
writeParagraph(
Javadoc::Paragraph const& para,
doc::Paragraph const& para,
llvm::StringRef tag)
{
tags_.open("para", {
Expand All @@ -678,24 +678,24 @@ writeParagraph(
void
XMLWriter::
writeAdmonition(
Javadoc::Admonition const& admonition)
doc::Admonition const& admonition)
{
llvm::StringRef tag;
switch(admonition.style)
{
case Javadoc::Admonish::note:
case doc::Admonish::note:
tag = "note";
break;
case Javadoc::Admonish::tip:
case doc::Admonish::tip:
tag = "tip";
break;
case Javadoc::Admonish::important:
case doc::Admonish::important:
tag = "important";
break;
case Javadoc::Admonish::caution:
case doc::Admonish::caution:
tag = "caution";
break;
case Javadoc::Admonish::warning:
case doc::Admonish::warning:
tag = "warning";
break;
default:
Expand All @@ -707,7 +707,7 @@ writeAdmonition(

void
XMLWriter::
writeCode(Javadoc::Code const& code)
writeCode(doc::Code const& code)
{
if(code.children.empty())
{
Expand All @@ -723,7 +723,7 @@ writeCode(Javadoc::Code const& code)
void
XMLWriter::
writeReturns(
Javadoc::Returns const& returns)
doc::Returns const& returns)
{
if(returns.empty())
return;
Expand All @@ -735,18 +735,18 @@ writeReturns(
void
XMLWriter::
writeJParam(
Javadoc::Param const& param)
doc::Param const& param)
{
const char* direction = nullptr;
switch(param.direction)
{
case Javadoc::ParamDirection::in:
case doc::ParamDirection::in:
direction = "in";
break;
case Javadoc::ParamDirection::out:
case doc::ParamDirection::out:
direction = "out";
break;
case Javadoc::ParamDirection::inout:
case doc::ParamDirection::inout:
direction = "inout";
break;
default:
Expand All @@ -763,7 +763,7 @@ writeJParam(
void
XMLWriter::
writeTParam(
Javadoc::TParam const& tparam)
doc::TParam const& tparam)
{
tags_.open("tparam", {
{ "name", tparam.name, ! tparam.name.empty() }});
Expand Down
20 changes: 10 additions & 10 deletions source/-XML/XMLWriter.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,16 +83,16 @@ class XMLWriter

template<class T>
void writeNodes(AnyList<T> const& list);
void writeNode(Javadoc::Node const& node);
void writeBrief(Javadoc::Paragraph const& node);
void writeText(Javadoc::Text const& node);
void writeStyledText(Javadoc::StyledText const& node);
void writeParagraph(Javadoc::Paragraph const& node, llvm::StringRef tag = "");
void writeAdmonition(Javadoc::Admonition const& node);
void writeCode(Javadoc::Code const& node);
void writeReturns(Javadoc::Returns const& node);
void writeJParam(Javadoc::Param const& node);
void writeTParam(Javadoc::TParam const& node);
void writeNode(doc::Node const& node);
void writeBrief(doc::Paragraph const& node);
void writeText(doc::Text const& node);
void writeStyledText(doc::StyledText const& node);
void writeParagraph(doc::Paragraph const& node, llvm::StringRef tag = "");
void writeAdmonition(doc::Admonition const& node);
void writeCode(doc::Code const& node);
void writeReturns(doc::Returns const& node);
void writeJParam(doc::Param const& node);
void writeTParam(doc::TParam const& node);
};

} // xml
Expand Down
68 changes: 34 additions & 34 deletions source/-adoc/AdocWriter.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -624,39 +624,39 @@ writeFunctionDeclaration(
void
AdocWriter::
writeNode(
Javadoc::Node const& node)
doc::Node const& node)
{
switch(node.kind)
{
case Javadoc::Kind::text:
writeNode(static_cast<Javadoc::Text const&>(node));
case doc::Kind::text:
writeNode(static_cast<doc::Text const&>(node));
return;
case Javadoc::Kind::styled:
writeNode(static_cast<Javadoc::StyledText const&>(node));
case doc::Kind::styled:
writeNode(static_cast<doc::StyledText const&>(node));
return;
#if 0
case Javadoc::Node::block:
writeNode(static_cast<Javadoc::Block const&>(node));
case doc::Node::block:
writeNode(static_cast<doc::Block const&>(node));
return;
#endif
case Javadoc::Kind::brief:
case Javadoc::Kind::paragraph:
writeNode(static_cast<Javadoc::Paragraph const&>(node));
case doc::Kind::brief:
case doc::Kind::paragraph:
writeNode(static_cast<doc::Paragraph const&>(node));
return;
case Javadoc::Kind::admonition:
writeNode(static_cast<Javadoc::Admonition const&>(node));
case doc::Kind::admonition:
writeNode(static_cast<doc::Admonition const&>(node));
return;
case Javadoc::Kind::code:
writeNode(static_cast<Javadoc::Code const&>(node));
case doc::Kind::code:
writeNode(static_cast<doc::Code const&>(node));
return;
case Javadoc::Kind::param:
writeNode(static_cast<Javadoc::Param const&>(node));
case doc::Kind::param:
writeNode(static_cast<doc::Param const&>(node));
return;
case Javadoc::Kind::tparam:
writeNode(static_cast<Javadoc::TParam const&>(node));
case doc::Kind::tparam:
writeNode(static_cast<doc::TParam const&>(node));
return;
case Javadoc::Kind::returns:
writeNode(static_cast<Javadoc::Returns const&>(node));
case doc::Kind::returns:
writeNode(static_cast<doc::Returns const&>(node));
return;
default:
// unknown kind
Expand All @@ -667,7 +667,7 @@ writeNode(
void
AdocWriter::
writeNode(
Javadoc::Block const&)
doc::Block const&)
{
// shouldn't get here
MRDOX_ASSERT(false);
Expand All @@ -676,27 +676,27 @@ writeNode(
void
AdocWriter::
writeNode(
Javadoc::Text const& node)
doc::Text const& node)
{
// Text nodes must be left aligned or
// doc::Text nodes must be left aligned or
// else they can be rendered up as code.
os_ << llvm::StringRef(node.string).ltrim() << '\n';
}

void
AdocWriter::
writeNode(
Javadoc::StyledText const& node)
doc::StyledText const& node)
{
switch(node.style)
{
case Javadoc::Style::bold:
case doc::Style::bold:
os_ << '*' << node.string << "*\n";
break;
case Javadoc::Style::mono:
case doc::Style::mono:
os_ << '`' << node.string << "`\n";
break;
case Javadoc::Style::italic:
case doc::Style::italic:
os_ << '_' << node.string << "_\n";
break;
default:
Expand All @@ -708,28 +708,28 @@ writeNode(
void
AdocWriter::
writeNode(
Javadoc::Paragraph const& node)
doc::Paragraph const& node)
{
writeNodes(node.children);
}

void
AdocWriter::
writeNode(
Javadoc::Admonition const& node)
doc::Admonition const& node)
{
writeNodes(node.children);
}

void
AdocWriter::
writeNode(
Javadoc::Code const& node)
doc::Code const& node)
{
os_ <<
"[,cpp]\n"
"----\n";
AnyList<Javadoc::Text> const& list(node.children);
AnyList<doc::Text> const& list(node.children);
if(! list.empty())
{
// measure the left margin
Expand All @@ -756,21 +756,21 @@ writeNode(
void
AdocWriter::
writeNode(
Javadoc::Param const& node)
doc::Param const& node)
{
}

void
AdocWriter::
writeNode(
Javadoc::TParam const& node)
doc::TParam const& node)
{
}

void
AdocWriter::
writeNode(
Javadoc::Returns const& node)
doc::Returns const& node)
{
}

Expand Down
Loading

0 comments on commit 6600fe7

Please sign in to comment.