Generating documentation for script code (MAML?)

I'm currently writing a lot of PowerShell script code, actually thousands of
lines. A lot of the code is utility code that is used from the other code. I
would like to generate documentation for all the functions in my utility
libraries so you can get help on them, and see intellisense in tools like
PrimalScript.

Sounds like I have to generate MAML files for my scripts. Does anyone has
any experience with this from scripts, I know it works for the .Net
extensions you write for PowerShell.

Serge

There was another thread on this topic in this group already that I missed:

http://www.microsoft.com/communities...feb6c639fb&p=1

But the approach taken there is way too simple. I was thinking more along
the lines of RDoc, the ruby documentation generator
(http://rdoc.sourceforge.net/doc/) that takes a very simple approach to
formatting the documentation text. You really don't want the verbose (to say
the least) XML format defined by MAML into your code.

I also wonder if it is the best approach to generate MAML from the inline
documentation, because all the cmdlets documentation will get cluttered with
the documentation on your own code. Not sure about that yet, bacause the
documentation is on the utility code that you actually want to reuse.

I actually also don't know if you can just add MAML files to the $PSHOME
folder, without underlying dll...

Any ideas?

Serge van den Oever [Macaw]
http://weblogs.asp.net/soever
"Serge van den Oever [Macaw]" wrote:

> I'm currently writing a lot of PowerShell script code, actually thousands of
> lines. A lot of the code is utility code that is used from the other code. I
> would like to generate documentation for all the functions in my utility
> libraries so you can get help on them, and see intellisense in tools like
> PrimalScript.
>
> Sounds like I have to generate MAML files for my scripts. Does anyone has
> any experience with this from scripts, I know it works for the .Net
> extensions you write for PowerShell.
>
> Serge