#37 ignore internal functions for JSDoc API documentation

scenarioo · Oct 9, 2016 · 9c1e510 · 9c1e510
1 parent 0614cbf
commit 9c1e510
Showing 1 changed file with 12 additions and 2 deletions.
diff --git a/src/docuWriter/docuWriter.js b/src/docuWriter/docuWriter.js
@@ -82,11 +82,13 @@ export function cleanBuild(options) {
 }
 
 /**
- * cleans specified build directory if required by options
+ * Clean specified build directory if required by options.
  *
  * @param buildOutputDir
  * @param options
  * @returns {Promise}
+ *
+ * @ignore
  */
 function cleanBuildOnStartIfEnabled(buildOutputDir, options) {
   if (options && options.cleanBuildOnStart) {
@@ -238,12 +240,17 @@ function getStepDataFromWebpage() {
     });
 }
 
+/**
+ * @ignore
+ */
 function getPageNameFromUrl(urlString) {
   return identifierSanitizer.sanitize(pageNameExtractor.getPageNameFromUrl(urlString));
 }
 
 /**
- * writes step xml file (000.xml, 001.xml, etc.)
+ * Write step xml file (000.xml, 001.xml, etc.)
+ *
+ * @ignore
  */
 function writeStepXml(stepTitle, currentScenario, absScenarioPath, additionalProperties) {
 
@@ -298,6 +305,9 @@ function writeStepXml(stepTitle, currentScenario, absScenarioPath, additionalPro
 
 }
 
+/**
+ * @ignore
+ */
 function saveScreenshot(stepCounter, absScenarioPath) {
   const screenShotDir = path.resolve(absScenarioPath, 'screenshots');
   const screenShotFileName = path.resolve(screenShotDir, leadingZeros(stepCounter) + '.png');