add xmldoc description to --list-targets

[ctaggart]

Only today did I discover the --list-targets option. Besides being able to make it a default option, it would be great if it included the description from the xmldoc.

It would be even better if listTargets() included the documentation for the target.

Perhaps it should be the xmldoc of the target function.

/// start a web server and watch for slide edits
let keepRunning() =
    use watcher = !! (slidesDir + "/**/*.*") |> WatchChanges (fun changes ->
         handleWatcherEvents changes
    )
    startWebServer ()
    traceImportant "Waiting for slide edits. Press any key to stop."
    System.Console.ReadKey() |> ignore
    watcher.Dispose()

Target "KeepRunning" keepRunning

Target "ReleaseSlides" (
    /// push the slides to GitHub gh-pages branch
    fun _ ->
    if gitOwner = "myGitUser" || gitProjectName = "MyProject" then
        failwith "You need to specify the gitOwner and gitProjectName in build.fsx"
    let tempDocsDir = __SOURCE_DIRECTORY__ @@ "temp/gh-pages"
    CleanDir tempDocsDir
    Repository.cloneSingleBranch "" (gitHome + "/" + gitProjectName + ".git") "gh-pages" tempDocsDir

    fullclean tempDocsDir
    CopyRecursive outDir tempDocsDir true |> tracefn "%A"
    StageAll tempDocsDir
    Git.Commit.Commit tempDocsDir "Update generated slides"
    Branches.push tempDocsDir
)

[halcwb]

Agree, the ability to provide some description for your targets would be very useful.

[matthid]

This might or might not be quite hard to do

[matthid]

You can actually set a description on a target via DSL (Description "Some text")