• Home
• io.shiftleft
• overflowdb-traversal_3
• 1.191
• source code
• DocFinder.scala

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

overflowdb.traversal.help.DocFinder.scala Maven / Gradle / Ivy

package overflowdb.traversal.help

object DocFinder {
  def findDocumentedMethodsOf(clazz: Class[_]): Iterable[StepDoc] = {
    clazz.getMethods.flatMap { method =>
      method.getAnnotations.find(_.isInstanceOf[Doc]).map { case docAnnotation: Doc =>
        StepDoc(
          clazz.getName,
          method.getName,
          StrippedDoc(docAnnotation.info, docAnnotation.longInfo.stripMargin, docAnnotation.example.stripMargin)
        )
      }
    }
  }

  case class StepDoc(traversalClassName: String, methodName: String, doc: StrippedDoc)
  case class StrippedDoc(info: String, longInfo: String, example: String)
}