Skip to content

Backport "compiler plugin Scaladoc: document phase requirement" to LTS #19162

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

Merged
merged 1 commit into from
Dec 8, 2023
Merged

Backport "compiler plugin Scaladoc: document phase requirement" to LTS #19162

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions compiler/src/dotty/tools/dotc/plugins/Plugin.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ sealed trait Plugin {
/** A standard plugin can be inserted into the normal compilation pipeline */
trait StandardPlugin extends Plugin {
/** Non-research plugins should override this method to return the phases
*
* The phases returned must be freshly constructed (not reused
* and returned again on subsequent calls).
*
* @param options commandline options to the plugin.
* @return a list of phases to be added to the phase plan
Expand All @@ -56,6 +59,9 @@ trait StandardPlugin extends Plugin {
*/
trait ResearchPlugin extends Plugin {
/** Research plugins should override this method to return the new phase plan
*
* Any plugin phases included in the plan must be freshly constructed (not reused
* and returned again on subsequent calls).
*
* @param options commandline options to the plugin, `-P:plugname:opt1,opt2` becomes List(opt1, opt2)
* @param plan the given phase plan
Expand Down