Document Java.Awt.Font - #437
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
@dalexsoto review |
1 similar comment
|
@dalexsoto review |
dalexsoto
left a comment
There was a problem hiding this comment.
docs/xml/Java.Awt.Font/NumericShaper.xml references nonexistent managed member NumericShaper.Range.EUROPEAN. The binding exposes NumericShaper.Range.European; please use that name so the documented example compiles.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 8e26f329-986c-4861-ad65-7581ed5469dd
|
@dalexsoto Fixed in 072a732: the managed API reference now uses NumericShaper.Range.European. |
|
@dalexsoto review |
There was a problem hiding this comment.
Pull request overview
This PR adds/updates XML documentation for the Java.Awt.Font namespace, replacing remaining placeholders and improving API reference text for TextAttribute, NumericShaper, and related range types.
Changes:
- Replaced the namespace-level “To be added.” summary with a concrete description.
- Removed placeholder
<value>elements acrossTextAttributeand added standard interop infrastructure docs where applicable. - Added/updated summaries for
Ranges,NumericShaper.Rangemembers, and parameter documentation inNumericShaper.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/xml/ns-Java.Awt.Font.xml | Adds a meaningful namespace summary. |
| docs/xml/Java.Awt.Font/TextAttribute.xml | Removes placeholders and documents interop infrastructure members. |
| docs/xml/Java.Awt.Font/Ranges.xml | Replaces placeholder summary with a concrete description of supported ranges. |
| docs/xml/Java.Awt.Font/NumericShaper+Range.xml | Fills in summaries for many range constants and infrastructure members. |
| docs/xml/Java.Awt.Font/NumericShaper.xml | Improves parameter docs (notably context) and retains reference links. |
Suppressed comments (1)
docs/xml/Java.Awt.Font/NumericShaper.xml:1254
- The "Java documentation" link in this member's points to the 3-parameter overload of NumericShaper.shape, but this binding is the 4-parameter overload that includes a NumericShaper.Range context. This makes the reference link/signature misleading; update the href and displayed signature to match the Range overload.
<param name="context">The context to which to convert the characters, such as <c>NumericShaper.Range.European</c>.</param>
<summary>Converts the digits in the text that occur between start and
start + count.</summary>
<remarks>
<para>
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
dalexsoto
left a comment
There was a problem hiding this comment.
The invalid managed member reference is fixed; no blocking issues remain.
Closes #213
Sources
java.awt.font.TextAttributejava.awt.font.NumericShaperjava.awt.font.NumericShaper.RangeNumericShapersourceValidation
To be addedplaceholders inJava.Awt.Fontandns-Java.Awt.Font.xml.git diff --check.