LPTK

package ddbtoaster

import squid.utils._
import stagerwr2.compiler.Embedding
import Embedding.Predef._
import Embedding.Quasicodes._
import squid.ir.BottomUpTransformer
import squid.ir.FixPointRuleBasedTransformer
import squid.ir.FixPointTransformer
import squid.ir.RewriteAbort

LPTK

Scaladoc Developer Guide

Introduction

Scaladoc is the tool that enables developers to automatically generate documentation for their Scala (and Java) projects. It is Scala's equivalent of the widely-used Javadoc tool. This means that Javadoc (and even doxygen) users will be familiar with Scaladoc from day 1: for them, it is most beneficial to check out the Scaladoc/Javadoc comparison tables and if necessary, skim through this document to understand specific features.

The rest of this tutorial is aimed at developers new to Scaladoc and other similar tools. It assumes a basic understanding of the Scala language, which is necessary to follow the examples given throughout the tutorial. For the user perspective on the Scaladoc-generated documentation, such as finding a class, understanding the page layout, navigating through diagrams, please refer to the Scaladoc User Guide.

The tutorial will start by a short motivation and then will explain the main concept in Scaladoc: the doc comment.

Why document?

LPTK

object GenPattern extends App {
  
  abstract class TypeBase(val name: String)
  trait Type[+T] { val base: TypeBase; val params: Seq[Type[_]]; override def toString = s"${base.name}[${params mkString ","}]" }
  
  
  type Rep[+T] = Node[T]
  
  trait Node[+T] { val typ: Type[T]; val args: Seq[_] }