Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Scaladoc/Javadoc links #22904

Open
patriknw opened this issue May 11, 2017 · 10 comments
Open

Scaladoc/Javadoc links #22904

patriknw opened this issue May 11, 2017 · 10 comments
Labels
3 - in progress Someone is working on this ticket help wanted Issues that the core team will likely not have time to work on t:docs

Comments

@patriknw
Copy link
Member

patriknw commented May 11, 2017 •
edited

We should make use of http://developer.lightbend.com/docs/paradox/latest/features/linking.html#scaladoc-directive

This task is not top priority, can be added after first release.
@raboof raboof added the nice-to-have (low-prio) Tasks which make sense, however are not very high priority, feel free to help out! label May 12, 2017
@patriknw patriknw added help wanted Issues that the core team will likely not have time to work on and removed nice-to-have (low-prio) Tasks which make sense, however are not very high priority, feel free to help out! labels May 29, 2017
@ktoso ktoso added help wanted Issues that the core team will likely not have time to work on and removed help wanted Issues that the core team will likely not have time to work on labels May 29, 2017
@patriknw patriknw added the 1 - triaged Tickets that are safe to pick up for contributing in terms of likeliness of being accepted label Jun 12, 2017
@richardimaoka
Copy link
Contributor

Working on this. Is it okay to open one pull request per one .md file like #23052 consolidate java/scala content ?

richardimaoka added a commit to richardimaoka/akka that referenced this issue Oct 14, 2017
@richardimaoka
Use scaladoc and javadoc directives in stages-overview.md (akka#22904)
b0f7a9a
@richardimaoka richardimaoka mentioned this issue Oct 14, 2017
Merged
richardimaoka added a commit to richardimaoka/akka that referenced this issue Oct 15, 2017
@richardimaoka
Use scaladoc and javadoc directives in stages-rate.md (akka#22904)
13616ba
@patriknw
Copy link
Member Author

That sounds great, thanks.
A few per PR would also be fine, whatever is convenient.

ktoso pushed a commit that referenced this issue Oct 23, 2017
@richardimaoka @ktoso
Use scaladoc and javadoc directives in stages-rate.md (#23811)
7c38cc1 
* Use scaladoc and javadoc directives in stages-rate.md (#22904)

* Update build.sbt
@ktoso ktoso removed the 1 - triaged Tickets that are safe to pick up for contributing in terms of likeliness of being accepted label Oct 23, 2017
@ktoso ktoso added this to the 2.5.7 milestone Oct 23, 2017
@richardimaoka
Copy link
Contributor

richardimaoka commented Oct 28, 2017 •
edited by johanandren

  • actors.md
  • additional/books.md - no update needed
  • additional/deploy.md - no update needed
  • additional/faq.md
  • additional/index.md
  • additional/osgi.md
  • agents.md
  • camel.md
  • cluster-client.md - @richardimaoka paradox javadoc and scaladoc directives for cluster-client.md #24524 Unidoc directives for cluster md files #24689
  • cluster-dc.md - @richardimaoka Unidoc directives for cluster md files #24689
  • cluster-metrics.md - @richardimaoka Unidoc directives for cluster md files #24689
  • cluster-sharding.md - @richardimaoka Unidoc directives for cluster md files #24689
  • cluster-singleton.md - @richardimaoka Unidoc directives for cluster md files #24689
  • cluster-usage.md
  • common/binary-compatibility-rules.md
  • common/circuitbreaker.md
  • common/cluster.md
  • common/duration.md
  • common/io-layer.md
  • common/may-change.md
  • common/other-modules.md
  • dispatchers.md
  • distributed-data.md
  • distributed-pub-sub.md
  • event-bus.md
  • extending-akka.md
  • fault-tolerance-sample.md
  • fault-tolerance.md
  • fsm.md
  • futures.md
  • general/actor-systems.md
  • general/actors.md
  • general/addressing.md
  • general/configuration.md
  • general/index.md
  • general/jmm.md
  • general/message-delivery-reliability.md
  • general/remoting.md
  • general/stream/stream-configuration.md
  • general/stream/stream-design.md
  • general/supervision.md
  • general/terminology.md
  • guide/actors-intro.md
  • guide/actors-motivation.md
  • guide/index.md
  • guide/introduction.md
  • guide/modules.md
  • guide/tutorial.md
  • guide/tutorial_1.md
  • guide/tutorial_2.md
  • guide/tutorial_3.md
  • guide/tutorial_4.md
  • guide/tutorial_5.md
  • howto.md
  • index-actors.md
  • index-cluster.md
  • index-futures.md
  • index-network.md
  • index-utilities.md
  • index.md
  • io-tcp.md
  • io-udp.md
  • io.md
  • java8-compat.md
  • logging.md
  • mailboxes.md
  • multi-jvm-testing.md
  • multi-node-testing.md
  • persistence-query-leveldb.md
  • persistence-query.md
  • persistence-schema-evolution.md
  • persistence.md
  • project/index.md
  • project/issue-tracking.md
  • project/licenses.md
  • project/links.md
  • project/migration-guide-1.3.x-2.0.x.md
  • project/migration-guide-2.0.x-2.1.x.md
  • project/migration-guide-2.1.x-2.2.x.md
  • project/migration-guide-2.2.x-2.3.x.md
  • project/migration-guide-2.3.x-2.4.x.md
  • project/migration-guide-2.4.x-2.5.x.md
  • project/migration-guide-eventsourced-2.3.x.md
  • project/migration-guide-persistence-experimental-2.3.x-2.4.x.md
  • project/migration-guide-stream-1.0-2.x.md
  • project/migration-guide-stream-2.0-2.4.md
  • project/migration-guides.md
  • remoting-artery.md
  • remoting.md
  • routing.md
  • scheduler.md
  • security/2017-02-10-java-serialization.md
  • security/2017-08-09-camel.md
  • security/index.md
  • serialization.md
  • stream/index.md
  • /stream/stages-overview.md
  • stream/stream-cookbook.md
  • stream/stream-customize.md
  • stream/stream-dynamic.md
  • stream/stream-error.md
  • stream/stream-flows-and-basics.md
  • stream/stream-graphs.md
  • stream/stream-integrations.md
  • stream/stream-introduction.md
  • stream/stream-io.md
  • stream/stream-parallelism.md
  • stream/stream-quickstart.md
  • stream/stream-rate.md - @richardimaoka Use scaladoc and javadoc directives in stages-rate.md #23811
  • stream/stream-refs.md
  • stream/stream-substream.md
  • stream/stream-testkit.md
  • testing.md
  • typed-actors.md
  • typed/actor-discovery.md
  • typed/actor-lifecycle.md
  • typed/actors.md
  • typed/cluster-sharding.md
  • typed/cluster-singleton.md
  • typed/cluster.md
  • typed/coexisting.md
  • typed/distributed-data.md
  • typed/fault-tolerance.md
  • typed/index.md
  • typed/interaction-patterns.md
  • typed/persistence.md
  • typed/stash.md
  • typed/stream.md
  • typed/testing.md

@patriknw patriknw added the 3 - in progress Someone is working on this ticket label Oct 30, 2017
lucianenache pushed a commit to lucianenache/akka that referenced this issue Nov 9, 2017
@richardimaoka
Use scaladoc and javadoc directives in stages-rate.md (akka#23811)
648cf2a 
* Use scaladoc and javadoc directives in stages-rate.md (akka#22904)

* Update build.sbt
@patriknw patriknw removed this from the 2.5.7 milestone Nov 17, 2017
@ktoso ktoso added t:docs and removed new-docs labels Dec 13, 2017
This was referenced Feb 11, 2018
Merged
Closed
@jrudolph
Copy link
Member

Btw. in akka-http we also have a @unidoc directive that will create both scaladoc and javadoc links trying some heuristic to automatically select symbols from either scaladsl or javadsl classes. See https://github.com/akka/akka-http/blob/f3e83935ffc27bc94f586d9387b54b499c6250d4/project/ParadoxSupport.scala#L47 for the sources. Might make sense to port the directive to akka proper as well or maybe even put it into akka-paradox (or even paradox itself) before tackling this ticket.

@ktoso
Copy link
Member

ktoso commented Feb 12, 2018

huge +1 to:

Might make sense to port the directive to akka proper as well or maybe even put it into akka-paradox (or even paradox itself) before tackling this ticket.

@richardimaoka richardimaoka mentioned this issue Feb 18, 2018
Closed
@raboof
Copy link
Member

raboof commented Mar 1, 2018

Since we just merged #24426 this one is unlocked again :)

@richardimaoka richardimaoka mentioned this issue Mar 8, 2018
Merged
johanandren pushed a commit that referenced this issue Mar 9, 2018
@richardimaoka @johanandren
Unidoc directives for cluster md files #22904
bcc86f7
johanandren added a commit that referenced this issue Mar 9, 2018
@johanandren
Revert "Unidoc directives for cluster md files #22904"
d93e565 
This reverts commit bcc86f7.
This was referenced Aug 13, 2022
Merged
Merged
patriknw pushed a commit that referenced this issue Aug 22, 2022
@Captain1653
Use apidoc directive in typed/persistence.md - second part (#22904) (#…
8c078e2 
…31494)
@Captain1653 Captain1653 mentioned this issue Aug 23, 2022
Merged
raboof pushed a commit that referenced this issue Aug 25, 2022
@Captain1653
Use apidoc directive in stream/stream-flows-and-basics.md (#22904) (#…
beeeeab 
…31489)
@Captain1653 Captain1653 mentioned this issue Aug 29, 2022
Merged
raboof pushed a commit that referenced this issue Aug 30, 2022
@Captain1653
Use apidoc directive in typed/guide/tutorial_4.md (#22904) (#31519)
e0724e1
@Captain1653 Captain1653 mentioned this issue Aug 30, 2022
Merged
raboof pushed a commit that referenced this issue Aug 30, 2022
@Captain1653
Use apidoc directive in typed/guide/tutorial_5.md (#22904) (#31520)
2fd69aa
@Captain1653 Captain1653 mentioned this issue Aug 30, 2022
Merged
patriknw pushed a commit that referenced this issue Sep 1, 2022
@Captain1653
docs: Use apidoc directive in classic cluster-usage.md (#22904) (#31521)
bd7f5ff 
* Use apidoc directive in classic cluster-usage.md (#22904)

* add links for expectMsgType and runOn
patriknw pushed a commit that referenced this issue Sep 1, 2022
@Captain1653
docs: Use apidoc directive in typed/persistence.md - the last part (#…
5b9e25e 
…22904) (#31495)

* Use apidoc directive in typed/persistence.md - the last part (#22904)

* add link for persist and remove link persistAll
@Captain1653 Captain1653 mentioned this issue Sep 5, 2022
Merged
johanandren pushed a commit that referenced this issue Sep 6, 2022
@Captain1653
Use apidoc directive in paradox/persistence-query.md (#22904) (#31554)
aa9968a
GreyPlane pushed a commit to GreyPlane/akka that referenced this issue Sep 9, 2022
@Captain1653 @GreyPlane
Use apidoc directive in paradox/persistence-query.md (akka#22904) (ak…
2d9036d 
…ka#31554)
Captain1653 added a commit to Captain1653/akka that referenced this issue Sep 26, 2023
@Captain1653
docs: Use apidoc directive in typed/fsm.md (akka#22904)
d8a2b90
@Captain1653 Captain1653 mentioned this issue Sep 26, 2023
Merged
johanandren pushed a commit that referenced this issue Sep 29, 2023
@Captain1653
docs: Use apidoc directive in typed/fsm.md (#22904) (#32133)
1833661
Captain1653 added a commit to Captain1653/akka that referenced this issue Oct 1, 2023
@Captain1653
docs: Use apidoc directive in io-udp.md (akka#22904)
b614160
@Captain1653 Captain1653 mentioned this issue Oct 1, 2023
Merged
johanandren pushed a commit that referenced this issue Oct 2, 2023
@Captain1653
docs: Use apidoc directive in io-udp.md (#22904) (#32147)
5405b27
Captain1653 added a commit to Captain1653/akka that referenced this issue Oct 7, 2023
@Captain1653
docs: Use apidoc directive in io-tcp.md - part 1 (akka#22904)
e5065c5
@Captain1653 Captain1653 mentioned this issue Oct 7, 2023
Merged
@Roiocam
Copy link
Contributor

Roiocam commented Oct 7, 2023

The document link has been updated to: https://developer.lightbend.com/docs/paradox/current/directives/linking.html#scaladoc-directive

johanandren pushed a commit that referenced this issue Oct 9, 2023
@Captain1653
docs: Use apidoc directive in io-tcp.md - part 1 (#22904) (#32166)
3d24594
Captain1653 added a commit to Captain1653/akka that referenced this issue Oct 11, 2023
@Captain1653
docs: Use apidoc directive in io-tcp.md - part 2 (akka#22904)
fef9de7
@Captain1653 Captain1653 mentioned this issue Oct 11, 2023
Merged
johanandren pushed a commit that referenced this issue Oct 12, 2023
@Captain1653
docs: Use apidoc directive in io-tcp.md - part 2 (#22904) (#32170)
dd381c1
He-Pin pushed a commit to He-Pin/akka that referenced this issue Jan 7, 2024
@Captain1653 @He-Pin
docs: Use apidoc directive in io-tcp.md - part 1 (akka#22904) (akka#3…
7a13493 
…2166)
He-Pin pushed a commit to He-Pin/akka that referenced this issue Jan 7, 2024
@Captain1653 @He-Pin
docs: Use apidoc directive in io-tcp.md - part 2 (akka#22904) (akka#3…
5a7c70c 
…2170)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
3 - in progress Someone is working on this ticket help wanted Issues that the core team will likely not have time to work on t:docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
7 participants
@jrudolph @ktoso @raboof @patriknw @Captain1653 @richardimaoka @Roiocam