class

Freshdoc::Scanner

Inherits Reference < Object

Ищет doc-комментарии с тегом @doc <id> в src/**/*.cr корня проекта. Лайновый скан: формат требует @doc последней строкой комментария непосредственно перед def/class/module/struct — этого достаточно.

Constants

DEF_RE = /^\s*(?:abstract\s+)?def\s+(?:self\.)?([a-zA-Z_][\w?!]*)([?(?]|$)/
DOC_RE = /^#\s*@doc\s+(\S+)\s*$/
TYPE_RE = /^\s*(?:abstract\s+)?(class|module|struct|enum)\s+([A-Z][\w:]*)/

Class methods

scan(root : String) : Array(ScannedDoc)
Source
scan_file(file : String, found : Array(ScannedDoc)) : Nil
Source