Skip to content

Commit b57884c

Browse files
pjcollinspjcollins
committed
Fix all remaining remarks translation errors
All 431 instances of `JavadocImport-Error` that would occur when generating API docs for Mono.Android.dll have been fixed.
1 parent fcc33ce commit b57884c

File tree

7 files changed

+679
-13
lines changed

7 files changed

+679
-13
lines changed

‎src/Java.Interop.Tools.JavaSource/Java.Interop.Tools.JavaSource/SourceJavadocToXmldocGrammar.BlockTagsBnfTerms.cs

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,12 +102,16 @@ internal void CreateRules (SourceJavadocToXmldocGrammar grammar)
102102
};
103103

104104
// Ignore @hide tags
105-
HideDeclaration.Rule = "@hide";
105+
HideDeclaration.Rule = "@hide"
106+
| "@hide" + BlockValues
107+
;
106108
HideDeclaration.AstConfig.NodeCreator = (context, parseNode) => {
107109
FinishParse (context, parseNode);
108110
};
109111

110-
InheritDocDeclaration.Rule = "@inheritDoc";
112+
InheritDocDeclaration.Rule = "@inheritDoc"
113+
| "@inheritDoc" + BlockValues
114+
;
111115
InheritDocDeclaration.AstConfig.NodeCreator = (context, parseNode) => {
112116
if (!grammar.ShouldImport (ImportJavadoc.InheritDocTag)) {
113117
return;
@@ -251,6 +255,7 @@ internal void CreateRules (SourceJavadocToXmldocGrammar grammar)
251255
}
252256
FinishParse (context, parseNode);
253257
};
258+
254259
}
255260

256261
public readonly NonTerminal AllBlockTerms = new NonTerminal (nameof (AllBlockTerms), ConcatChildNodes);
@@ -283,6 +288,7 @@ internal void CreateRules (SourceJavadocToXmldocGrammar grammar)
283288
public readonly NonTerminal ThrowsDeclaration = new NonTerminal (nameof (ThrowsDeclaration));
284289
public readonly NonTerminal UnknownTagDeclaration = new NonTerminal (nameof (UnknownTagDeclaration));
285290
public readonly NonTerminal VersionDeclaration = new NonTerminal (nameof (VersionDeclaration));
291+
286292
}
287293
}
288294
}

‎src/Java.Interop.Tools.JavaSource/Java.Interop.Tools.JavaSource/SourceJavadocToXmldocGrammar.HtmlBnfTerms.cs

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ internal void CreateRules (SourceJavadocToXmldocGrammar grammar)
3434
| FormCtrlDeclaration
3535
*/
3636
| InlineHyperLinkDeclaration
37+
| AnchorNameDeclaration
3738
| grammar.InlineTagsTerms.AllInlineTerms
3839
| UnknownHtmlElementStart
3940
,
@@ -59,11 +60,11 @@ internal void CreateRules (SourceJavadocToXmldocGrammar grammar)
5960
parseNode.AstNode = "";
6061
};
6162

62-
var fontstyle_tt = CreateHtmlToCrefElement (grammar, "tt", "c", InlineDeclarations);
63-
var fontstyle_i = CreateHtmlToCrefElement (grammar, "i", "i", InlineDeclarations);
63+
var fontstyle_tt = CreateHtmlToCrefElement (grammar, "tt", "c", InlineDeclarations, optionalEnd: true);
64+
var fontstyle_i = CreateHtmlToCrefElement (grammar, "i", "i", InlineDeclarations, optionalEnd: true);
6465

6566
var preText = new PreBlockDeclarationBodyTerminal ();
66-
PreBlockDeclaration.Rule = CreateStartElement ("pre", grammar) + preText + CreateEndElement ("pre", grammar);
67+
PreBlockDeclaration.Rule = CreateStartElementIgnoreAttribute ("pre") + preText + CreateEndElement ("pre", grammar, optional: true);
6768
PreBlockDeclaration.AstConfig.NodeCreator = (context, parseNode) => {
6869
if (!grammar.ShouldImport (ImportJavadoc.Remarks)) {
6970
parseNode.AstNode = "";
@@ -125,6 +126,12 @@ internal void CreateRules (SourceJavadocToXmldocGrammar grammar)
125126
parseNode.AstNode = astNodeElement;
126127
}
127128
};
129+
130+
// Remove obsolete <a name=""></a> HTML content
131+
AnchorNameDeclaration.Rule = CreateStartElementIgnoreAttribute ("a", "name") + InlineDeclarations + CreateEndElement ("a", grammar, optional: true);
132+
AnchorNameDeclaration.AstConfig.NodeCreator = (context, parseNode) => {
133+
FinishParse (context, parseNode);
134+
};
128135
}
129136

130137
static IEnumerable<XElement> GetParagraphs (ParseTreeNodeList children)
@@ -193,8 +200,9 @@ static IEnumerable<XElement> GetParagraphs (ParseTreeNodeList children)
193200
public readonly NonTerminal PBlockDeclaration = new NonTerminal (nameof (PBlockDeclaration), ConcatChildNodes);
194201
public readonly NonTerminal PreBlockDeclaration = new NonTerminal (nameof (PreBlockDeclaration), ConcatChildNodes);
195202
public readonly NonTerminal InlineHyperLinkDeclaration = new NonTerminal (nameof (InlineHyperLinkDeclaration), ConcatChildNodes);
203+
public readonly NonTerminal AnchorNameDeclaration = new NonTerminal (nameof (AnchorNameDeclaration), ConcatChildNodes);
196204

197-
public readonly Terminal InlineHyperLinkOpenTerm = new RegexBasedTerminal ("<a href=", @"<a\s*href=") {
205+
public readonly Terminal InlineHyperLinkOpenTerm = new RegexBasedTerminal ("<a href=", @"(?i)<a\s*href\s*=") {
198206
AstConfig = new AstNodeConfig {
199207
NodeCreator = (context, parseNode) => parseNode.AstNode = "",
200208
},
@@ -231,6 +239,20 @@ static NonTerminal CreateStartElement (string startElement, Grammar grammar)
231239
return start;
232240
}
233241

242+
static RegexBasedTerminal CreateStartElementIgnoreAttribute (string startElement, string attribute)
243+
{
244+
return new RegexBasedTerminal ($"<{startElement} attribute", $@"(?i)<{startElement}\s*{attribute}[^>]*>") {
245+
AstConfig = new AstNodeConfig {
246+
NodeCreator = (context, parseNode) => parseNode.AstNode = "",
247+
},
248+
};
249+
}
250+
251+
static RegexBasedTerminal CreateStartElementIgnoreAttribute (string startElement)
252+
{
253+
return CreateStartElementIgnoreAttribute (startElement, "");
254+
}
255+
234256
static NonTerminal CreateEndElement (string endElement, Grammar grammar, bool optional = false)
235257
{
236258
var end = new NonTerminal (endElement, nodeCreator: (context, parseNode) => parseNode.AstNode = "") {

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

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ internal void CreateRules (SourceJavadocToXmldocGrammar grammar)
2828
| LiteralDeclaration
2929
| SeeDeclaration
3030
| ValueDeclaration
31+
| IgnorableDeclaration
3132
;
3233

3334
CodeDeclaration.Rule = grammar.ToTerm ("{@code") + InlineValue + "}";
@@ -54,12 +55,24 @@ internal void CreateRules (SourceJavadocToXmldocGrammar grammar)
5455
parseNode.AstNode = new XText ("To be added");
5556
};
5657

57-
LinkDeclaration.Rule = grammar.ToTerm ("{@link") + InlineValue + "}";
58+
// Some {@link tags are missing a closing bracket, still attempt to match a target value
59+
LinkDeclaration.Rule = grammar.ToTerm ("{@link") + InlineValue + "}"
60+
| new RegexBasedTerminal ("BrokenLinkTargetValue", "(?!.*}){@link [^ \n\r\t,.]*") {
61+
AstConfig = new AstNodeConfig {
62+
NodeCreator = (context, parseNode) => parseNode.AstNode = parseNode.Token.Value,
63+
},
64+
};
65+
;
5866
LinkDeclaration.AstConfig.NodeCreator = (context, parseNode) => {
5967
// TODO: *everything*; {@link target label}, but target can contain spaces!
6068
// Also need to convert to appropriate CREF value, use code text for now.
61-
var target = parseNode.ChildNodes [1].AstNode;
62-
parseNode.AstNode = new XElement ("c", target);
69+
if (parseNode.ChildNodes.Count > 1) {
70+
var target = parseNode.ChildNodes [1].AstNode;
71+
parseNode.AstNode = new XElement ("c", target);
72+
} else {
73+
var target = parseNode.ChildNodes [0].AstNode;
74+
parseNode.AstNode = new XElement ("c", target.ToString ().Replace ("{@link ", ""));
75+
}
6376
};
6477

6578
LinkplainDeclaration.Rule = grammar.ToTerm ("{@linkplain") + InlineValue + "}";
@@ -97,6 +110,15 @@ internal void CreateRules (SourceJavadocToXmldocGrammar grammar)
97110
parseNode.AstNode = new XText ("To be added");
98111
}
99112
};
113+
114+
// Inline content may contain reserved characters with no tags or special parsing rules, do not throw when encountering them
115+
IgnorableDeclaration.Rule = grammar.ToTerm ("@ ")
116+
| grammar.ToTerm ("{")
117+
| grammar.ToTerm ("}")
118+
;
119+
IgnorableDeclaration.AstConfig.NodeCreator = (context, parseNode) => {
120+
parseNode.AstNode = new XText (parseNode.ChildNodes [0].Term.Name.Trim ());
121+
};
100122
}
101123

102124
public readonly NonTerminal AllInlineTerms = new NonTerminal (nameof (AllInlineTerms), ConcatChildNodes);
@@ -129,6 +151,9 @@ internal void CreateRules (SourceJavadocToXmldocGrammar grammar)
129151

130152
// https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#value
131153
public readonly NonTerminal ValueDeclaration = new NonTerminal (nameof (ValueDeclaration));
154+
155+
public readonly NonTerminal IgnorableDeclaration = new NonTerminal (nameof (IgnorableDeclaration));
156+
132157
}
133158
}
134159
}

‎tests/Java.Interop.Tools.JavaSource-Tests/SourceJavadocToXmldocGrammar.BlockTagsBnfTermsTests.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,11 @@ public void InheritDocDeclaration ()
6565
Assert.IsFalse (r.HasErrors (), "@inheritDoc: " + DumpMessages (r, p));
6666
// TODO: Enable after adding support for @inheritDoc
6767
Assert.IsNull (r.Root.AstNode, "@inheritDoc should be ignored, but node was not null.");
68+
69+
r = p.Parse ("@inheritDoc With extra");
70+
Assert.IsFalse (r.HasErrors (), "@inheritDoc with trailing content " + DumpMessages (r, p));
71+
// TODO: Enable after adding support for @inheritDoc
72+
Assert.IsNull (r.Root.AstNode, "@inheritDoc with trailing content should be ignored, but node was not null.");
6873
}
6974

7075
[Test]
@@ -75,6 +80,9 @@ public void HideDeclaration ()
7580
var r = p.Parse ("@hide");
7681
Assert.IsFalse (r.HasErrors (), "@hide: " + DumpMessages (r, p));
7782
Assert.IsNull (r.Root.AstNode, "@hide should be ignored, but node was not null.");
83+
r = p.Parse ("@hide Method is broken");
84+
Assert.IsFalse (r.HasErrors (), "@hide with trailing content: " + DumpMessages (r, p));
85+
Assert.IsNull (r.Root.AstNode, "@hide with trailing content should be ignored, but node was not null.");
7886
}
7987

8088
[Test]

‎tests/Java.Interop.Tools.JavaSource-Tests/SourceJavadocToXmldocGrammar.HtmlBnfTermsTests.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ public void PreBlockDeclaration ()
4646
Assert.AreEqual ("<code lang=\"text/java\">this @contains &lt;arbitrary/&gt; text.</code>",
4747
r.Root.AstNode.ToString ());
4848

49+
r = p.Parse ("<pre class=\"prettyprint\">ColorSpace cs = ColorSpace.get(ColorSpace.Named.DCI_P3);");
50+
Assert.IsFalse (r.HasErrors (), DumpMessages (r, p));
51+
Assert.AreEqual ($"<code lang=\"text/java\">ColorSpace cs = ColorSpace.get(ColorSpace.Named.DCI_P3);</code>",
52+
r.Root.AstNode.ToString ());
4953
}
5054

5155
[Test]

0 commit comments

Comments
 (0)