Comments resulting with > and %:lt; strings.

[urosjarc]

For the following languages, docs comments do not result in the correct format: c, cpp, cs, java, js, ts. For python the docs are correct.

SOURCE

    /// <summary>
    /// Pretvori šteilko v osmiški zapis.
    /// </summary>
    /// <param name="a">Cela številka v desetiškem zapisu.</param>
    /// <returns>Cela številka v osmiškem zapisu.</returns>

c

/**
 * <summary>
 * Pretvori šteilko v osmiški zapis.
 * </summary>
 * <param name="a">Cela številka v desetiškem zapisu.</param>
 * <returns>Cela številka v osmiškem zapisu.</returns>
 */

cpp

    /**
     * <summary>
     * Pretvori šteilko v osmiški zapis.
     * </summary>
     * <param name="a">Cela številka v desetiškem zapisu.</param>
     * <returns>Cela številka v osmiškem zapisu.</returns>
     */

cs

    /// <summary>&lt;summary&gt;
    /// Pretvori šteilko v osmiški zapis.</summary>
    /// <remarks>&lt;/summary&gt;
    /// &lt;param name="a"&gt;Cela številka v desetiškem zapisu.&lt;/param&gt;
    /// &lt;returns&gt;Cela številka v osmiškem zapisu.&lt;/returns&gt;</remarks>

java

    /**
     * <summary>
     * Pretvori šteilko v osmiški zapis.
     * </summary>
     * <param name="a">Cela številka v desetiškem zapisu.</param>
     * <returns>Cela številka v osmiškem zapisu.</returns>
     */

js

/**
 * <summary>
 * Pretvori šteilko v osmiški zapis.
 * </summary>
 * <param name="a">Cela številka v desetiškem zapisu.</param>
 * <returns>Cela številka v osmiškem zapisu.</returns>
 */

python

        """<summary>
        Pretvori šteilko v osmiški zapis.

        </summary>
        <param name="a">Cela številka v desetiškem zapisu.</param>
        <returns>Cela številka v osmiškem zapisu.</returns>"""

ts

    /**
     * <summary>
     * Pretvori šteilko v osmiški zapis.
     * </summary>
     * <param name="a">Cela številka v desetiškem zapisu.</param>
     * <returns>Cela številka v osmiškem zapisu.</returns>
     */

[pfusik]

This is expected. You are using C# syntax of XML tags in documentation comments. Use Ć syntax for documentation comments instead.

[urosjarc]

Can you reopen this issue, I'm interested to fixing this in pull request because it seems a simple fix. Maybe if I could make it so that docs comments result in official docs comments for every language like JSDocs, Doxygen etc...

[pfusik]

What would you like to fix here? If you type < in a Ć doc comment, it means you want to see < in the generated documentation and therefore it needs to be escaped in C#, Java and Doxygen syntax.

[urosjarc]

Hmmm, I don't understand you... This is docs comments created for C#, and for me this is wrong...

    /// <summary>&lt;summary&gt;
    /// Pretvori šteilko v osmiški zapis.</summary>
    /// <remarks>&lt;/summary&gt;
    /// &lt;param name="a"&gt;Cela številka v desetiškem zapisu.&lt;/param&gt;
    /// &lt;returns&gt;Cela številka v osmiškem zapisu.&lt;/returns&gt;</remarks>

[pfusik]

Just use Ć syntax, also for documentation comments (see the link above). cito transpiles documentation comments as well.

C:\0\ci>cat ticket72.ci
public class Foo
{
        /// Pretvori šteilko v osmiški zapis.
        /// Returns cela številka v osmiškem zapisu.
        public void Bar(
                /// Cela številka v desetiškem zapisu.
                int a)
        {
        }
}

C:\0\ci>cito -o ticket72.cs ticket72.ci

C:\0\ci>cat ticket72.cs
// Generated automatically with "cito". Do not edit.

public class Foo
{

        /// <summary>Pretvori šteilko v osmiški zapis.</summary>
        /// <remarks>Returns cela številka v osmiškem zapisu.</remarks>
        /// <param name="a">Cela številka v desetiškem zapisu.</param>
        public void Bar(int a)
        {
        }
}

[urosjarc]

Ooooooohhhhhhh I see now what you did there, thank you for clarification, I didn't found this in the docs.

[urosjarc]

Does this works for returning tag? return

[pfusik]

There is no support for the <returns> tag. I'd love to have it added! That could be your first PR. Note that:

1. It should be supported for all the target languages, not just C#.
2. I'd prefer lightweight Markdown style and not some XML or JavaDoc tags. How about a doc comment line starting with the "Returns" word?