Giter Club home page Giter Club logo

Comments (8)

pfusik avatar pfusik commented on September 23, 2024

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

from fut.

urosjarc avatar urosjarc commented on September 23, 2024

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...

from fut.

pfusik avatar pfusik commented on September 23, 2024

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.

from fut.

urosjarc avatar urosjarc commented on September 23, 2024

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>

from fut.

pfusik avatar pfusik commented on September 23, 2024

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)
        {
        }
}

from fut.

urosjarc avatar urosjarc commented on September 23, 2024

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

from fut.

urosjarc avatar urosjarc commented on September 23, 2024

Does this works for returning tag? return

from fut.

pfusik avatar pfusik commented on September 23, 2024

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?

from fut.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.