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.

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

DOC208: Convert Javadoc to XML doc #51

Open
drewnoakes opened this issue Sep 20, 2018 · 1 comment
Open

DOC208: Convert Javadoc to XML doc #51

drewnoakes opened this issue Sep 20, 2018 · 1 comment
Labels

Comments

@drewnoakes
Copy link

This might be a bit far out for this project but I wanted to capture something that bugged me a while ago when converting Java to C# and performing very mechanical transformations on Javadoc comments.

/**
 * The number of elements in the queue. The length
 * indicates the number of elements that are currently
 * in the queue.
 *
 * @return the number of elements in the queue
 */

Becomes:

/// <summary>
/// The number of elements in the queue. The length
/// indicates the number of elements that are currently
/// in the queue.
/// </summary>
/// <returns>the number of elements in the queue</returns>

Even without perfect support for all Javadoc idioms, this could still save a lot of time, especially if applied solution-wide.

@sharwell
Copy link
Member

This would not be too difficult if we leverage the work we'll have to put into #17, #3 (and related), and #15 (and related).

@sharwell sharwell changed the title Convert Javadoc to XML doc DOC205:Convert Javadoc to XML doc Sep 21, 2018
@sharwell sharwell changed the title DOC205:Convert Javadoc to XML doc DOC205: Convert Javadoc to XML doc Sep 21, 2018
@sharwell sharwell changed the title DOC205: Convert Javadoc to XML doc DOC208: Convert Javadoc to XML doc Oct 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants