2 * Copyright © 2016-2017 European Support Limited
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 * @module plugins/steptag
28 newDoclet: function(e) {
29 var tags = e.doclet.tags;
33 // any user-defined tags in this doclet?
34 if (typeof tags !== 'undefined') {
36 tags = tags.filter(function($) {
37 return $.title === 'step' || $.title === 'examplefile';
44 let exampleFile = null;
46 if (tags[tag].title === "step") {
47 step = "<b>" + tags[tag].value + "</b><br>";
49 if (tags[tag].title === "examplefile") {
50 exampleFile = "<i> Example Features File: " + tags[tag].value + "</i><br>";
53 if (exampleFile !== null) {
56 e.doclet.meta = e.doclet.meta || {};
57 if (e.doclet.description !== undefined) {
58 e.doclet.description = step + e.doclet.description;
60 e.doclet.description = step;