Page MenuHomePhabricator

C# bindings: Convert Eo comment format into proper XML comment format
Closed, ResolvedPublic

Description

Some work still remains so that EO comments are available to C# without losing information.

These are the problems I have identified so far (there might be more):

  • Keywords marked as $name do not render monospaced and look weird. They should be enclosed in <c>name</c> tags.
  • Cross links using the @name sign need to be renamed the same way the C# classes are renamed, and turned into <see cref="name"/> tags.
  • <param> tags need the name attribute so they can be used.
  • Return type of getter methods should be documented with <returns> (it should be the same string as the input parameter to the setter method, I guess)
  • <para> tags must be inside <summary> tags.
  • <returns> tag is misspelled as <return>.
  • \@ tags are to be ignored (as in \@ref). They should only appear in legacy docs and are meant to go straight into doxygen without processing by eolian.
segfaultxavi triaged this task as Normal priority.
segfaultxavi renamed this task from C# bindings: Convert Eo comment format into proper XML comments to C# bindings: Convert Eo comment format into proper XML comment format.Nov 6 2018, 5:38 AM
segfaultxavi updated the task description. (Show Details)

The regular param tags already use the name attribute in function parameters. It was missing from the constructors but I added it to the new API branch.

segfaultxavi updated the task description. (Show Details)Nov 8 2018, 8:43 AM
segfaultxavi updated the task description. (Show Details)Nov 8 2018, 9:12 AM
segfaultxavi updated the task description. (Show Details)Nov 8 2018, 10:06 AM
segfaultxavi updated the task description. (Show Details)Nov 8 2018, 10:26 AM
segfaultxavi updated the task description. (Show Details)Nov 14 2018, 4:05 AM

This is almost done in my branch. I only need to translate EO class and method names in comment links into the C# managed names. I'm already using the same helper methods used throughout the generator.

segfaultxavi updated the task description. (Show Details)Nov 23 2018, 1:34 AM

About the <value> tag on properties. Should we create a new task or it would be a new item here?

segfaultxavi raised the priority of this task from Normal to High.