What style of code comments are required for daml damlc docs?
App Development2 posts78 views1 likesLast activity Apr 2025
WA
WallaceKellyOP
Apr 2025Running daml damlc docs on the following does not copy the comments to the generated docs:
-- an asset is a thing that can be owned by a user
template Asset
with
-- the issuer of the asset
issuer : Party
owner : Party
name : Text
What comment style is expected by the daml damlc docs (aka, “damldocs”) command?
WA
WallaceKelly
Apr 2025The daml damlc docs command is looking for Haddock-style annotations. However, see this caveat.
For the following:
-- | an asset is a thing that can be owned by a user
template Asset
with
issuer : Party
-- ^ the issuer of the asset
owner : Party
name : Text
The command:
daml damlc docs -o docs --doc-ext md daml/Main.daml
Generates:
You can see examples in the Daml Standard Library and the Splice code base.
