v0.10.0-rc.1 10th September 2014

Minor refactoring

• chore(package.json): fix path to tests in npm scripts 2924a3ac
• chore(package.json): remove pre and post install hooks 6dd05b21
• chore(examples): move tests into source folder f128fede
• chore(ngdoc): move tests into source folder b5df9a16
• chore(nunjucks): move tests into source folder cce54a00
• chore(jsdoc): move tests into source folder 9b337073
• chore(base): move tests into source folder 43b64bbf

v0.10.0-beta.4 6th September 2014

Refactorings

ComputeIdsProcessor

The major refactoring in this release was to move computation of ids (and aliases, which used to be called partialIds) into a generic computeIdsProcessor in the base package. This is then configured (similar to computePathsProcessor) for each docType that a package introduces.

• fix(ngdoc): fix idTemplate for member docTypes dbad1945
• fix(examples): add idTemplates for examples docTypes 16086476
• fix(ngdoc/getDocFromAlias): start from scratch if filtering by area fails f742f5a3
• fix(ngdoc/getLinkInfo): pass through currentDoc when searching for member 039deedf
• refact(computeIdsProcessor): rename partialIds to aliases 00607193
• refact(base/aliasMap): remove unused reference to lodash 3321da6b
• refact(ngdoc): use computeIdProcessor and aliasMap 569312c9
• refact(getPartialNames): rename to getAliases ee83af87
• feat(ngdoc/getDocFromAlias): add service to find relative docs from alias bef71895
• refact(base/computeIdProcessor): rename partialIdMap to aliasMap e336bbc3
• refact(partialIdMap): rename to aliasMap 46075fb3
• feat(base/computeIdsProcessor): add new processor to compute ids based on configuration templates aeec7e1e
• feat(base/partialIdMap): add new service for storing partial ids 1c3f82ab
• refact(base/computePathsProcessor): always regenerate the maps on $process 4caa96c7
• refact(ngdoc/getAliases): combine getPartialNames and parseCodeName into getAliases 2d3071f0
• refact(ngdoc/getLinkInfo): use getDocFromAlias 0cc9f490
• refact(ngdoc/computeIdProcessor): remove and use base/computeIdsProcessor e17d808c
• test(jsdoc): disable computeIdsProcessor for test e303f3c7
• refact(ngdoc/partialNameMap): remove and use aliasMap from base instead 925c01a1
• docs(ngdoc/getDocFromAlias): document the service 167a982b
• fix(base/computeIdsProcessor): improve error messages 88ea6e10
• fix(jsdoc): provide basic getPartialIds function 54dc8118
• refact(jsdoc): update to use computeIdsProcessor 2938a4c5

apiDocsProcessor

Also the apiDocsProcessor was broken up. Part of it is now handled by the computeIdsProcessor but the rest was refactored into membersDocsProcessor and moduleDocsProcessor.

• refact(ngdoc/generateComponentGroupsProcessor): apiDocs is going away 1fbed695
• refact(ngdoc/apiDocsProcessor): remove old processor c1a2fee0
• refact(ngdoc/moduleDocsProcessor): use getDocFromAlias fa0408ca
• refact(ngdoc/memberDocsProcessor): use getDocFromAlias 74063d3f
• fix(ngdoc/memberDocsProcessor): test and ensure doc.memberof is a full id f6b063dd
• fix(ngdoc/moduleDocsProcessor): run after memberDocsProcessor c3fd9398
• fix(ngdoc/moduleDocsProcessor): better resolve ambiguous module references b27d8ff7
• test(ngdoc/moduleDocsProcessor): test the processor 3e42370c
• refact(ngdoc): reorganization of processors and services c7397fa1
• feat(ngdoc/moduleDocsProcessor): extract functionality from apiDocsProcessor 8cd51dc4
• feat(ngdoc/memberDocsProcessor): extract functionality from apiDocsProcessor c7302275

v0.10.0-beta.3 15th August 2014

The major change in this release was the removal of dependency on the ES6-shim and the use of ES6 Map for storing maps of information. The shimmed Map was not playing nicely with Jasmine, Nunjucks and console.log. Instead these mappings are now using StringMap, which is cleaner than using bare objects (made from Object.create(null)).

Thanks as always to Stéphane for his translations and removal of unused code.

• refact(*) : remove unused dependencies 5c893d85
• refact(examples/exampleMap): rename and convert to a StringMap bdbb7c26
• fix(ngdoc/templates): fix github links 2f01d163
• fix(examples): use computePathsProcessor for example file paths c4b02945
• fix(examples/generateExamplesProcessor): ensure correct files are in manifest dc60336e
• fix(ngdoc/templates): ensure github links are to valid paths 7676f187
• feat(base/readFilesProcessor): add projectRelativePath to fileInfo 7931f230
• fix(examples): ensure example index files have correct path e5e62554
• refact(jsdoc/moduleMap): use a StringMap to store the modules 0c37674a
• refact(TagColletion) use StringMap for tagsByName property d6655cf0
• refact(jsdoc/parseTagsProcessor): use StringMap b61e3e20
• refact(jsdoc/inlineTagProcessor): use StringMap 33f6e5fc
• refact(computePathsProcessor): use stringmap and no longer allow default template 93fc95cf
• refact(base/readFilesProcessor): use stringmap for fileReaderMap be33702c
• fix(ngdoc/macro.html): default param values are in `doc. e3899b67
• fix(partialNameMap): use pure object to prevent property collisions 3750c928
• refact(*): remove dependency on 'es6-shim' and Map 15751dfb

v0.10.0-beta.2 7th August 2014

Bug fixes and refactoring. The big change in this revision is the introduction of the computePathsProcessor.

• refact(examples): use computePathsProcessor f85487f7
• refact(examples/parseExamplesProcessor): ditch using ES6 Map for examples c7d2b6db
• refact(examples/generateExamplesProcessor): ditch using ES6 Map for examples a770bf91
• refact(examples/runnableExample inlineTag): ditch using ES6 Map for examples f1b463dc
• feat(examples/generateProtractorTestsProcessor): add new processor from Angular.js c08b9be4
• refact(examples/examples): ditch using ES6 Map 37ac555c
• fix(ngdoc): ensure API docs go into 'partials' folder e9aa9f81
• fix(ngdoc/generateComponentGroupsProcessor): use moduleName and moduleDoc rather than module a0f32a03
• fix(ngdoc/module tagDef): don't calc module if docType is "overview" ba819910
• fix(ngdoc/area tagDef): docs now use relativePath not filePath 620a2b07
• fix(createDocMessage): docs now use relativePath not filePath efb7397c
• fix(computePaths): use log.debug not console.log 1a8f18ba
• refact(examples/templates): move files up a folder 7e7fdea5
• feat(base/createDocMessage): include docType in message 7add32a5
• feat(base/computePathsProcessor): improve error messages 14086ed2
• refact(examples): use computePathProcessor from base package f6891e9b
• fix(computeIdProcessor): don't compute if id is already defined bab945be
• refact(ngdoc): use computePathProcessor from base package fe187590
• fix(jsdoc): add 'js' docType path template a3d5f5b1
• feat(jsdoc file-reader): give each read doc a docType of "js" 2f15a7cf
• refact(jsdoc): use computePathProcessor from base package 90adbf8b
• refact(jsdoc/computePathProcessor): use the computePathProcessor from base package a2e7a6f8
• feat(computePathsProcessor): add configurable processor 15179ce5

v0.10.0-beta.1 25th July 2014

This is a major rearchitecture in line with changing to dgeni@0.4.0

There are numerous breaking changes surrounding this release and that of dgeni 0.4.0. The most important changes are

• Configuration is done directly on the Processors and Services using Configuration Blocks, which are defined on Packages.

• Everything is now dependency injected. Dgeni deals with instantiating Processors and Services but if you have properties on these that reference objects that should also be instantiated by the DI system then you can either ask for them to be injected into the config block:

  myPackage.config(function(processor1, someObj) {
    processor1.someProp = someObj;
  });
  

  use the injector directly:

  myPackage.config(function(processor1, injector) {
    processor1.someProp = injector.invoke(someObjFactory);
  });
  

  or use the getInjectables() helper service:

  myPackage.config(function(processor1, getInjectables) {
    processor1.someProp = getInjectables([someObjFactory, someOtherObjFactory]);
  });
  

• All real processors have changed their names from dash-case to camelCase. This is because it is easier for their names to be valid JavaScript identifiers.

The most significant commits are:

• fix(utils/code): encode HTML entities 13b99152
• feat(base/debugDumpProcessor): add new processor 4c126792
• feat(dgeni package): add initial package for documenting dgeni configurations 2bfa92b2
• refact(parseExamplesProcessor): use Map() for example.files d926879a
• fix(ngdoc/module tag-def): module is the first segment of the relative path 649f3051
• fix(jsdoc/description tag-def): capture non-tag specific description ed68438d
• feat(base/createDocMessage): add new service db11bc44
• fix(*): doc.file is now doc.fileInfo.filePath fb600502
• fix(ngdoc/collectPartialNamesProcessor): compute-id was renamed to computeIdProcessor 0158fb3b
• fix(ngdoc/apiDocs): compute-path was renamed to computePathProcessor 9396f8c3
• fix(ngdoc/apiDocsProcessor): compute-id was renamed to computeIdProcessor a83d7fc9
• feat(ngdoc package): add getTypeClass service addebf63
• refact(base/code): rename to encodeCodeBlock 2ae134ff
• feat(getTypeClass): add new service 9c49ff9d
• fix(ngdocFileReader): must have an explicit name 9c5dd397
• test(nunjucks/templateEngine): templateEngine now relies on templateFinder 0269acf5
• fix(nunjucks/marked custom tag): add service name for DI injection 9069c24f
• refact(trimIndentation): convert to DI service 3ab6c9ed
• fix(nunjucks/templateEngine): get the templateFolders from the templateFinder 8760aa7f
• fix(inlineTagProcessor): inline tag definitions are optional 380dd474
• fix(computePathProcessor): let writeFileProcessor deal with outputFolder 4057deb8
• fix(jsdoc fileReader): file-readers need explicit names cad6d043
• fix(jsdoc package): pseudo processors need to use $runBefore, etc. 5d32020f
• fix(renderDocsProcessor): extra and helpers and optional 6bc1f16a
• fix(readFilesProcessor): resolve include and exclude paths correctly f7ea5f78
• refact(computePathProcessor): read outputFolder config from writeFilesProcessor 828b48c3
• feat(api-docs): allow packageName to be specified as a tag 83c7e1fa
• fix(jsdoc package): add trimWhitespaceTransform to package 75f52df1
• refact(templateFinder): now call getFinder() to get the actual function e8c015d9
• refact(jsdoc transforms): convert to DI services 5e92ff46
• feat(ngdocs/moduleMap): add new service to support apiDocsProcessor et al 19a37a27
• fix(runnableExample inline-tag): examples is now a Map d1857779
• test(tag-defs): split out tests into separate files 9be421f7
• fix(jsdoc package): jsdocFileReader should be loaded as a service 0c92271c
• refact(ngdoc/tag-defs): convert to DI injectables d8512597
• refact(ngdoc/link inline tag): convert to DI injectable 77e51df3
• refact(ngdoc/code tag): convert to DI injectable 1d23cd4e
• refact(ngdoc/code filter): convert to DI injectable 8c871b3d
• feat(getLinkInfo): add new service 32aa8427
• refact(partialNameMap): rename and convert to DI service 49acc949
• feat(getPartialNames): add new service c6326268
• feat(parseCodeName): add new service e02fe91c
• refact(base/services): move code and trimIndentation to be DI services 00d17816
• refact(examples service): move to its own service (as part of no-config update) 16d7819e
• refact(renderDocsProcessor): templateEngine now has a getRenderer() method 4f50737b
• refact(jsdoc): convert transforms to services 6dc5417f
• refact(extractTagsProcessor): move computation into smaller functions fa1821c1
• refact(tagExtractor): move into the extractTagsProcessor 49e51da4
• refact(tagParser): move into the parseTagsProcessor efba4e9b
• feat(read-files): add path exclusion and update to no-config 6853d759
• refact(*): update to use new processor configuration style c54fd8d6
• refact(*): use new dgeni Packages 128c2e61