puppet doc does not include comments in the code

[cg2506]

Hi all,

I try puppet doc for documentation of our manifests and modules to see what they do. So the documentaion should explain what happens in the files like "In this manifest we setup system abc with software xyz" to get new employees on the track when they start using puppet. Currently I have the problem that comments in the code are not processed.

For example:

# File: centos.pp <br>
# Class: baseline::centos
# = Headline
# Example headline
# == Sub Headline
# Example sub headline
class baseline::centos {

  # this command will not be processed
  exec { 'some_pretty_command':
    path   => '/bin',
    onlyif => 'grep foobar /etc/motd',
  }

  # this command will not be processed too
  file { '/etc/motd':
    owner  => 'root',
    group  => 'root',
    mode   => '0644',
  }

}

The header will be processed but not the comments later in the code. It would be good to have all the comments in the documentation.

Any help will be welcome!

Regards, Christian