nix-community / nixdoc

Tool to generate documentation for Nix library functions [maintainer=@infinisil]
GNU General Public License v3.0
123 stars 15 forks source link

Only render multiline-comments as descriptions #92

Closed infinisil closed 9 months ago

infinisil commented 9 months ago

This should not render the "Some text":

# Some
# text
{
  foo = ...;
}

Only this should:

/*
  Some
  text
*/
{
  foo = ...;
}

This aligns with single-line comments being ignored for functions too.

Ping @phaer, since it was originally introduced in #70