Skip to content
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

Fix Bugs in Swift Doc-Comment Generation #3122

Merged
merged 3 commits into from
Nov 11, 2024
Merged

Fix Bugs in Swift Doc-Comment Generation #3122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
15b6e9e
Fixed various issues with slice2swift doc comments.
InsertCreativityHere Nov 6, 2024
7841758
Minor fixes to other things I found.
InsertCreativityHere Nov 11, 2024
2e7b762
Swift uses '/' as it's doc-comment scope separator.
InsertCreativityHere Nov 11, 2024
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
4 changes: 2 additions & 2 deletions cpp/src/Slice/Parser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -659,15 +659,15 @@ namespace

// Fix any link tags using the provided link formatter.
const string link = "{@link ";
pos = comment.find(link, pos);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There was no point to passing in pos, it's just 0 here.

pos = comment.find(link);
while (pos != string::npos)
{
string::size_type endpos = comment.find('}', pos);
if (endpos != string::npos)
{
// Extract the linked to identifier.
string::size_type identStart = comment.find_first_not_of(" \t", pos + link.size());
string::size_type identEnd = comment.find_last_not_of(" \t", endpos) + 1;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bug in my previous comment-formatting PR that caused us to read one character past the link's identifier.

string::size_type identEnd = comment.find_last_not_of(" \t", endpos);
string ident = comment.substr(identStart, identEnd - identStart);

// Then erase the entire '{@link foo}' tag from the comment.
Expand Down
Loading