Giter Club home page Giter Club logo

Comments (8)

Simn avatar Simn commented on May 30, 2024

I agree it would be nice to have this. We would have to encode this into the field structure somehow, maybe using our own metadata.

from dox.

Simn avatar Simn commented on May 30, 2024

@dpeek: Are you going to look into this? It seems to be a blocking issue for multiple projects.

from dox.

Simn avatar Simn commented on May 30, 2024

Any remaining problems with the java-doc branch?

from dox.

aduros avatar aduros commented on May 30, 2024

Multiline tags would be cool. Things like this don't parse correctly right now:

/**
 * The description of a method.
 *
 * @param pName A long description of a parameter that
 *   spills into multiple lines.
 */

from dox.

Simn avatar Simn commented on May 30, 2024

https://github.com/dpeek/dox/blob/java-doc/src/dox/JavadocHandler.hx#L18

This is missing the s flag, but I think it should actually be something like ~/@(\w+) ([^@]+)/g

from dox.

aduros avatar aduros commented on May 30, 2024

Also, it looks like @return / @returns isn't being rendered?

from dox.

Simn avatar Simn commented on May 30, 2024

Fixed.

For future references, you may want to play around with https://github.com/dpeek/dox/blob/master/templates/doc.mtt. You could also look into making it look prettier. :D

from dox.

Simn avatar Simn commented on May 30, 2024

I suppose this is resolved.

from dox.

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.