Skip to content

Improve documentation tags in generated code #250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
karthiknadig merged 3 commits into from
Jul 17, 2023
Merged

Improve documentation tags in generated code #250

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fa2dd52
Disable Python for temporarily
karthiknadig Jul 14, 2023
852fba1
Restore other tests
karthiknadig Jul 17, 2023
21cb69b
Improve documentation tags in generated code
karthiknadig Jul 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion generator/plugins/dotnet/dotnet_helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,28 @@

from generator import model

BASIC_LINK_RE = re.compile(r"{@link +(\w+) ([\w ]+)}")
BASIC_LINK_RE2 = re.compile(r"{@link +(\w+)\.(\w+) ([\w \.`]+)}")
BASIC_LINK_RE3 = re.compile(r"{@link +(\w+)}")
BASIC_LINK_RE4 = re.compile(r"{@link +(\w+)\.(\w+)}")
PARTS_RE = re.compile(r"(([a-z0-9])([A-Z]))")


def _fix_links(line: str) -> str:
line = BASIC_LINK_RE.sub(r'<see cref="\1">\2</see>', line)
line = BASIC_LINK_RE2.sub(r'<see cref="\1.\2">\3</see>', line)
line = BASIC_LINK_RE3.sub(r'<see cref="\1" />', line)
line = BASIC_LINK_RE4.sub(r'<see cref="\1.\2" />', line)
return line


def lines_to_doc_comments(lines: List[str]) -> List[str]:
if not lines:
return []

return (
["/// <summary>"]
+ [f"/// {line}" for line in lines if not line.startswith("@")]
+ [f"/// {_fix_links(line)}" for line in lines if not line.startswith("@")]
+ ["/// </summary>"]
)

Expand Down