Giter VIP home page Giter VIP logo

Comments (5)

srowen avatar srowen commented on August 30, 2024

I find this as well, and also links that include a URL in [[...]]. I think these have to undergo more translation to be valid javadoc, and Java 8 flags them as errors not warnings.

from genjavadoc.

patriknw avatar patriknw commented on August 30, 2024

a pull request would be awesome ;-)

from genjavadoc.

rkuhn avatar rkuhn commented on August 30, 2024

This is a current limitation: scaladoc comments are not parsed and interpreted , only minimal substitutions are made. This means that [[...]] syntax can only be used to link to Java classes. All other uses are illegal.

I mark this as an enhancement so that someone can pick it up if interested.

from genjavadoc.

patriknw avatar patriknw commented on August 30, 2024

Another thing to be careful with is [[methodName]] links. Those are not understood by genjavadoc. Intellij complains about [[#methodName]] syntax and you might replace them with [[methodName]].

[[#methodName]] and [[Class#methodName]] works fine. The latter is not a warning in Intellij.

from genjavadoc.

tisonkun avatar tisonkun commented on August 30, 2024

@patriknw we don't support args in methodName yet? I try to write links like [[FileIO.toFile(File, util.Set[OpenOption])]] but it was rendered as <span class="extype" name="FileIO.toPath(Path,">util.Set[OpenOption])</span> which is neither a link nor a good display.

See also akka/akka#28328

from genjavadoc.

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.