Skip to content

Commit

Permalink
Adding backwards compatibility with previous scaffold conventions
Browse files Browse the repository at this point in the history
Adding option to manually specify dlls to generate docs for in generate.fsx to provide upgrade path for
older projects.
  • Loading branch information
Vidar L. Sømme committed Apr 7, 2015
1 parent ff65300 commit 03234e7
Showing 1 changed file with 25 additions and 8 deletions.
33 changes: 25 additions & 8 deletions docs/tools/generate.template
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
// (the generated documentation is stored in the 'docs/output' directory)
// --------------------------------------------------------------------------------------

// Binaries that have XML documentation (in a corresponding generated XML file)
// Any binary output / copied to bin/projectName/projectName.dll will
// automatically be added as a binary to generate API docs for.
// for binaries output to root bin folder please add the filename only to the
// referenceBinaries list below in order to generate documentation for the binaries.
// (This is the original behaviour of ProjectScaffold prior to multi project support)
let referenceBinaries = []
// Web site location for the generated documentation
let website = "/##ProjectName##"

Expand Down Expand Up @@ -85,16 +92,26 @@ let references =
else None

let binaries =
directoryInfo bin
|> subDirectories
|> Array.map (fun d -> d.FullName @@ (sprintf "%s.dll" d.Name))
|> List.ofArray
let manuallyAdded =
referenceBinaries
|> List.map (fun b -> bin @@ b)

let conventionBased =
directoryInfo bin
|> subDirectories
|> Array.map (fun d -> d.FullName @@ (sprintf "%s.dll" d.Name))
|> List.ofArray

conventionBased @ manuallyAdded

let libDirs =
directoryInfo bin
|> subDirectories
|> Array.map (fun d -> d.FullName)
|> List.ofArray
let conventionBasedbinDirs =
directoryInfo bin
|> subDirectories
|> Array.map (fun d -> d.FullName)
|> List.ofArray

conventionBasedbinDirs @ [bin]

// Build API reference from XML comments
let buildReference () =
Expand Down

0 comments on commit 03234e7

Please sign in to comment.