Skip to content

Commit 4cbc07a

Browse files
authored
[Java.Interop.Tools.JavaSource] Replace TODO with To be added (#937)
Context: #843 Context: #907 Replaces `[TODO: @tag]` values in generated docs with `To be added` to better mirror `mdoc` behavior for missing elements. Inline `{@value }` tags that contain an argument have been updated to display the argument in a `<c/>` block. These should be fixed to use an appropriate CREF in the future; see #843.
1 parent 312fbf4 commit 4cbc07a

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

src/Java.Interop.Tools.JavaSource/Java.Interop.Tools.JavaSource/SourceJavadocToXmldocGrammar.InlineTagsBnfTerms.cs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ internal void CreateRules (SourceJavadocToXmldocGrammar grammar)
4141

4242
InheritDocDeclaration.Rule = grammar.ToTerm ("{@inheritDoc}");
4343
InheritDocDeclaration.AstConfig.NodeCreator = (context, parseNode) => {
44-
parseNode.AstNode = new XText ("[TODO: @inheritDoc]");
44+
// TODO: Iterate through parents for corresponding javadoc element.
45+
parseNode.AstNode = new XText ("To be added");
4546
};
4647

4748
LinkDeclaration.Rule = grammar.ToTerm ("{@link") + InlineValue + "}";
@@ -70,11 +71,13 @@ internal void CreateRules (SourceJavadocToXmldocGrammar grammar)
7071
| grammar.ToTerm ("{@value") + InlineValue + "}";
7172
ValueDeclaration.AstConfig.NodeCreator = (context, parseNode) => {
7273
if (parseNode.ChildNodes.Count > 1) {
74+
// TODO: Need to convert to appropriate CREF value, use code text for now.
7375
var field = parseNode.ChildNodes [1].AstNode.ToString ();
74-
parseNode.AstNode = new XText ($"[TODO: @value for `{field}`]");
76+
parseNode.AstNode = new XElement ("c", field);
7577
}
7678
else {
77-
parseNode.AstNode = new XText ("[TODO: @value]");
79+
// TODO: Display the value of the corresponding static field.
80+
parseNode.AstNode = new XText ("To be added");
7881
}
7982
};
8083
}

tests/Java.Interop.Tools.JavaSource-Tests/SourceJavadocToXmldocGrammar.InlineTagsBnfTermsTests.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public void InheritDocDeclaration ()
4141

4242
var r = p.Parse ("{@inheritDoc}");
4343
Assert.IsFalse (r.HasErrors (), DumpMessages (r, p));
44-
Assert.AreEqual ("[TODO: @inheritDoc]", r.Root.AstNode.ToString ());
44+
Assert.AreEqual ("To be added", r.Root.AstNode.ToString ());
4545
}
4646

4747
[Test]
@@ -82,11 +82,11 @@ public void ValueDeclaration ()
8282

8383
var r = p.Parse ("{@value}");
8484
Assert.IsFalse (r.HasErrors (), DumpMessages (r, p));
85-
Assert.AreEqual ("[TODO: @value]", r.Root.AstNode.ToString ());
85+
Assert.AreEqual ("To be added", r.Root.AstNode.ToString ());
8686

8787
r = p.Parse ("{@value #field}");
8888
Assert.IsFalse (r.HasErrors (), DumpMessages (r, p));
89-
Assert.AreEqual ("[TODO: @value for `#field`]", r.Root.AstNode.ToString ());
89+
Assert.AreEqual ("<c>#field</c>", r.Root.AstNode.ToString ());
9090
}
9191
}
9292
}

0 commit comments

Comments
 (0)