Comments (5)
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.
a pull request would be awesome ;-)
from genjavadoc.
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.
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.
@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)
- Use latest JDKs in TravisCI builds HOT 1
- Invalid javadoc generated when using Scala 2.13.4 HOT 4
- Release for Scala 2.12.14 HOT 4
- java.util.NoSuchElementException: None.get in BasicTransform.deprecationInfo HOT 2
- Publish for Scala 2.12.15, please? HOT 2
- Publish for Scala 2.13.8, please? HOT 1
- Publish for Scala 2.12.16, please HOT 2
- new method incorrectly generated since Scala 2.12.3 HOT 1
- Publish for Scala 2.12.17 HOT 2
- publish for Scala 2.13.9 HOT 1
- Please publish for Scala 2.13.10 HOT 3
- Publish for Scala 2.12.18, please? HOT 1
- Publish for Scala 2.13.11, please? HOT 5
- Update release instructions for back-publishing HOT 4
- Please publish for Scala 2.13.12 HOT 2
- Please publish for Scala 2.12.19 and 2.13.13 HOT 3
- genjavadoc is broken with Scala 2.13.13 HOT 2
- Roll a release HOT 4
- Support for Scala 3? HOT 2
- Please publish for Scala 2.13.14 HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from genjavadoc.