| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
| |
This reverts commit 831f09bb6d00c152bd8aef3ce8bf9e200080fe36.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
This commit contains model changes required for adding class diagrams
to scaladoc. It also contains an improved implicit shadowing
computation, which hides the shadowed implicitly inherited members
from the main view and gives instructions on how to access them.
This is joint work with Damien Obrist (@damienobrist) on supporting
diagram generation in scaladoc, as part of Damien's semester project
in the LAMP laborarory at EPFL.
The full history is located at:
https://github.com/damienobrist/scala/tree/feature/diagrams-dev
Commit summary:
- diagrams model
- diagram settings (Settings.scala, ScalaDoc.scala)
- diagram model object (Entity.scala, Diagram.scala)
- model: tracking direct superclasses and subclasses,
implicit conversions from and to (ModelFactory.scala)
- diagram object computation (DiagramFactory.scala, DocFactory.scala)
- capacity to filter diagrams (CommentFactory.scala,
DiagramDirectiveParser.scala)
- diagram statistics object (DiagramStats.scala)
- delayed link evaluation (Body.scala, Comment.scala)
- tests
- improved implicits shadowing information
- model shadowing computation (ModelFactoryImplicitSupport.scala,
Entity.scala)
- html generation for shadowing information (Template.scala)
- tests
Also fixes an issue reported by @dragos, where single-line comment
expansion would lead to the comment disappearing.
Review by @kzys, @pedrofurla.
|
| |
|
|
|
| |
If a package have a package object, generate the package's "linearization"
from the object.
|
| |
|
|
|
| |
* all usages of ClassManifest and Manifest are replaced with tags
* all manifest tests are replaced with tag tests
|
| |
|
|
| |
and implicit pimped on members. Thanks to Lukas for pointing it out!
|
| | |
|
| |
|
|
|
|
|
| |
See https://github.com/VladUreche/scala/tree/feature/doc-implicits for the history.
See https://scala-webapps.epfl.ch/jenkins/view/scaladoc/job/scaladoc-implicits-nightly/ for nightlies.
Many thanks fly out to Adriaan for his help with implicit search!
|
| |\
| |
| |
| |
| | |
Conflicts:
test/scaladoc/scala/html/HtmlFactoryTest.scala
|
| | |
| |
| |
| |
| | |
and fixed a pesky crash in the syntax highlighting caused by invalid
chars (0x0E) in MarkupParser.scala.
|
| |/ |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
From now on, the usecases inherit the comments from their parents, such
as the explanation and the annotations: @param, @tparam, @return, etc.
An example of usecase comment inheritance is:
/**
* The test function tests the parameter param for ...
*
* @param theParam the implicit parameter to be tested for ...
* @return the result of the test
*
*
*
* @usecase def test(): Bool
*
* The test function tests the parameter taken implicitly from scope.
* Example: `test()`
*
* @return the result of the test for the current scope
*
*
*
* @usecase def test(theParam: SomeType): Bool
*
* This takes the explicit value passed.
* Example: `test(3)`
*
* @param theParam the explicit parameter to be tested for ...
*/
def test(implicit theParam: SomeType): Bool
Notice both usecases override the explanation with their own examples.
The first usecase also overrides the "@return" annotation while the 2nd
usecase overrides the "@param theParam" annotation. If they didn't
override the explanations and annotations, they would inherit the
values from the actual implementation, def test(implicit ...)
This will be followed by @inheritdoc, which enables more fine-grained
control over comment inheritance. The full explanation of using comment
inheritance and @inheritdoc and their interaction with variables is
given at https://wiki.scala-lang.org/display/SW/Tags+and+Annotations
in the "Comment inheritance" and "Inheritance Example" sections.
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
The documents with use cases should be restructured like:
/**
* The full definition, either used with an implicit value or with an explicit one.
*
* Some more explanation on implicits...
*
* @param lost a lost parameter
* @return some integer
*
* @usecase def test(): Int
*
* This takes the implicit value in scope.
*
* Example: `test()`
*
* @usecase def test(explicit: Int): Int
*
* This takes the explicit value passed.
*
* Example: `test(3)`
*/
def test(implicit lost: Int): Int
|
| |
|
|
|
|
|
|
|
|
| |
If use cases are present, the original member disappears from the list.
References SI-5054, but needs more work on the html part. If use cases
are present along with links, scaladoc doesn't crash anymore. Closes
SI-4898.
Review by kzys.
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
Add "Google tokens for Scala" for symbolic names on Scaladoc. Review by
ureche.
We can't use Scala's symbolic names on Google. Instead of waiting
Google, we'll introduce mapping from the names to equivalent searchable
representations. This idea proposed by Grzegorz Kossakowski.
https://groups.google.com/group/scala-internals/browse_thread/thread/413
dbc691542f76f
|
| | |
|
| | |
|
| | |
|
| |
|
|
|
|
| |
Scaladoc shouldn't drop type arguments to aliased tuple. Related to
SI-4676. Review by pedrofurla.
|
| | |
|
| | |
|
| | |
|
| |
|
|
|
|
| |
The '#' sign may easily to lead to problems, So we use '_' instead of
'#'. Closes #4641.
|
| |
|
|
|
|
| |
[scaladoc] Strike-through for deprecated symbols on the reference index.
Closes #4471. Review by dubochet.
|
| | |
|
| | |
|
| |
|
|
|
|
| |
Every tag element (even @define and @usecase) end before the next
recognised tag. Closes #4409. Review by extempore.
|
| |
|
|
|
|
| |
Put "\n" between superclass's comment and subclass's. Closes #4289.
Review by pedrofurla.
|
| |
|
|
|
| |
Fix for parsing bug in scaladoc closes #4420, no review.
|
| |
|
|
|
|
| |
one-member refinements, for bigger ones printing the number of members.
Should be improved. Closes #484, no review.
|
| | |
|
| |
|
|
|
|
| |
[scaladoc] Scaladoc should expand macros recursively. Closes #3484.
Review by dubochet.
|
| |
|
|
|
|
| |
[scaladoc] Don't create broken link to private companion object. Closes
#4374. Review by pedrofurla.
|
| | |
|
| |
|
|
|
| |
[scaladoc] Add a test of colon and parentheses (#4372). No review.
|
| | |
|
| | |
|
| | |
|
| | |
|
|
|
[scaladoc] Add HtmlFactoryTest and reorganize directory structure.
Reviewed by pedrofurla.
|
