chore: render @consume at the consume modifier

Author: hamzaremmal

scaladoc/src/dotty/tools/scaladoc/api.scala

@@ -45,6 +45,7 @@ enum Modifier(val name: String, val prefix: Boolean):
   case Infix extends Modifier("infix", true)
   case AbsOverride extends Modifier("abstract override", true)
   case Update extends Modifier("update", true)
+  case Consume extends Modifier("consume", true)
 
 case class ExtensionTarget(name: String, typeParams: Seq[TypeParameter], argsLists: Seq[TermParameterList], signature: Signature, dri: DRI, position: Long)
 case class ImplicitConversion(from: DRI, to: DRI)

scaladoc/src/dotty/tools/scaladoc/tasty/BasicSupport.scala

@@ -57,7 +57,7 @@ trait BasicSupport:
       )
       val fqNameAllowlist =
         if ccEnabled then
-          fqNameAllowlist0 + CaptureDefs.useAnnotFullName + CaptureDefs.consumeAnnotFullName
+          fqNameAllowlist0 + CaptureDefs.useAnnotFullName
         else fqNameAllowlist0
       val documentedSymbol = summon[Quotes].reflect.Symbol.requiredClass("java.lang.annotation.Documented")
       val annotations = sym.annotations.filter { a =>

scaladoc/src/dotty/tools/scaladoc/tasty/ClassLikeSupport.scala

@@ -23,7 +23,7 @@ trait ClassLikeSupport:
 
   extension (symbol: Symbol) {
     def getExtraModifiers(): Seq[Modifier] =
-      val mods = SymOps.getExtraModifiers(symbol)()
+      val mods = SymOps.getExtraModifiers(symbol)(self)
       if ccEnabled && symbol.flags.is(Flags.Mutable)then
         mods :+ Modifier.Update
       else
@@ -452,12 +452,13 @@ trait ClassLikeSupport:
   ) =
     val symbol = argument.symbol
     val inlinePrefix = if symbol.flags.is(Flags.Inline) then "inline " else ""
+    val comsumePrefix = if self.ccEnabled && symbol.hasAnnotation(cc.CaptureDefs.ConsumeAnnot) then "consume " else ""
     val name = symbol.normalizedName
     val nameIfNotSynthetic = Option.when(!symbol.flags.is(Flags.Synthetic))(name)
     val defaultValue = Option.when(symbol.flags.is(Flags.HasDefault))(Plain(" = ..."))
     api.TermParameter(
       symbol.getAnnotations(),
-      inlinePrefix + prefix(symbol),
+      comsumePrefix + inlinePrefix + prefix(symbol),
       nameIfNotSynthetic,
       symbol.dri,
       argument.tpt.asSignature(classDef, symbol.owner) :++ defaultValue,

scaladoc/src/dotty/tools/scaladoc/tasty/SymOps.scala

@@ -82,27 +82,43 @@ object SymOps:
 
 
     // Order here determines order in documenation
-    def getExtraModifiers(): Seq[Modifier] =
+    def getExtraModifiers(parser: TastyParser): Seq[Modifier] =
       import reflect._
-      Seq(
-        Flags.Final -> Modifier.Final,
-        Flags.Sealed -> Modifier.Sealed,
-        Flags.Erased -> Modifier.Erased,
-        Flags.Abstract -> Modifier.Abstract,
-        Flags.Deferred -> Modifier.Deferred,
-        Flags.Implicit -> Modifier.Implicit,
-        Flags.Infix -> Modifier.Infix,
-        Flags.Transparent -> Modifier.Transparent,
-        Flags.Inline -> Modifier.Inline,
-        Flags.Lazy -> Modifier.Lazy,
-        Flags.Open -> Modifier.Open,
-        Flags.Override -> Modifier.Override,
-        Flags.Case -> Modifier.Case,
-        Flags.Opaque -> Modifier.Opaque,
-        Flags.AbsOverride -> Modifier.AbsOverride,
-      ).collect {
-        case (flag, mod) if sym.flags.is(flag) => mod
-      }
+      def getModifiersFromFlags: Seq[Modifier] =
+        Seq(
+          Flags.Final -> Modifier.Final,
+          Flags.Sealed -> Modifier.Sealed,
+          Flags.Erased -> Modifier.Erased,
+          Flags.Abstract -> Modifier.Abstract,
+          Flags.Deferred -> Modifier.Deferred,
+          Flags.Implicit -> Modifier.Implicit,
+          Flags.Infix -> Modifier.Infix,
+          Flags.Transparent -> Modifier.Transparent,
+          Flags.Inline -> Modifier.Inline,
+          Flags.Lazy -> Modifier.Lazy,
+          Flags.Open -> Modifier.Open,
+          Flags.Override -> Modifier.Override,
+          Flags.Case -> Modifier.Case,
+          Flags.Opaque -> Modifier.Opaque,
+          Flags.AbsOverride -> Modifier.AbsOverride,
+        ).collect {
+          case (flag, mod) if sym.flags.is(flag) => mod
+        }
+      end getModifiersFromFlags
+
+      def isConsumeModifier(sym: Symbol): Boolean =
+        parser.ccEnabled && sym.hasAnnotation(cc.CaptureDefs.ConsumeAnnot)
+
+      def getModifiersFromAnnotations: Seq[Modifier] =
+        Seq (
+          isConsumeModifier -> Modifier.Consume
+        ).collect {
+          case (predicate, mod) if predicate(sym) => mod
+        }
+      end getModifiersFromAnnotations
+
+      getModifiersFromFlags ++ getModifiersFromAnnotations
+    end getExtraModifiers
 
     def isHiddenByVisibility(using dctx: DocContext): Boolean =
       import VisibilityScope._