| Reporter |
Drew Noakes (drewnoakes)
|
|---|---|
| Created | Jan 18, 2012 4:37:47 AM |
| Updated | Aug 12, 2015 11:06:08 AM |
| Assignee | Alisa Afonina (alisa.afonina) |
| Priority | Normal |
| State | Submitted |
| Type | Feature |
| Target Wave | Undefined |
| Fixed In Wave | Undefined |
| Affected Wave | No affected wave |
| Subsystem | Context Actions |
| Fix versions | No Fix versions |
| Affected versions | 6.1 |
| Fixed in builds | No Fixed in build |
| VsVersion | All Versions |
On several occasions I've ported some Java code to C# and spent quite a while manually adjusting the API documentation.
Becomes:
The most common Javadoc attributes are available in C# (@param, @return). Some Javadoc has HTML within it, which may be harder to convert (but not always impossible). I'd be happy to do those transformations myself, as even the simple conversion I show above takes a lot of work when done manually.
/**
* 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>
The most common Javadoc attributes are available in C# (@param, @return). Some Javadoc has HTML within it, which may be harder to convert (but not always impossible). I'd be happy to do those transformations myself, as even the simple conversion I show above takes a lot of work when done manually.