drasil-code-0.1.9.0: A framework for code and document generation for scientific software - Code SubPackage
Safe HaskellNone
LanguageGHC2024

Language.Drasil.Code.Imperative.Comments

Description

Contains functions for generating code comments that describe a chunk.

Synopsis

Documentation

getComment :: CodeIdea c => c -> GenState String Source #

Generates a comment string for a chunk, including the term, definition (if applicable), and unit (if applicable).

getCommentBrief :: CodeIdea c => c -> GenState String Source #