search

scala / bug

Scala 2 bug reports only. Please, no questions — proper bug reports only.
https://scala-lang.org
232 stars 21 forks source link

Allow user-provided doclet (patch included) #4102

Closed scabug closed 13 years ago

scabug commented 13 years ago

= problem =

Changing the output of the scaladoc tool is difficult, plus there is no facility to provide entirely different output, if desired.

= analysis =

Javadoc allowed for user-provided doclet to be specified that allowed the user to take advantage of the parsing, but do their own output. This would work the same way.

= enhancement recommendation =

Included is a patch that creates a trait, Doclet, that takes the Universe as a parameter and then does whatever it wants. This includes a default implementation that does what scaladoc does now.

If this pattern is deemed acceptable, I believe the next steps are to rigorously document the model classes and traits (which I'd be happy to work on), and for there to be one simple third-party doclet as a proof of concept.

This makes very few changes to how things work now; one can imagine a richer set of doclet support classes, akin to Javadocs, or some hooks into the existing "doclet", but for now, this is enough to let someone get started with custom scaladoc output but not have to worry about the compiler.

scabug commented 13 years ago

Imported From: https://issues.scala-lang.org/browse/SI-4102?orig=1 Reporter: Dave Copeland (davetron5000) Attachments:

scabug commented 13 years ago

Dave Copeland (davetron5000) said: patch that applies against 23760 to allow using a custom doclet

scabug commented 13 years ago

Dave Copeland (davetron5000) said: It appears that r24054 imlements a similar, but more sophisticated version, of what my patch includes.

scabug commented 13 years ago

@dubochet said: Indeed, r24504 is closing this issue.

For your information, the plugin design in r24504 is still open to modifications if it does not allow relevant use cases, or makes them unnecessarily complex. Please, let me know if you have such an example.