voluptatumnemo/helpers/documentation-helper.js

Solidity Documentation Generator

"use strict";

module.exports = {
  get: function(contents, key) {
    contents = contents || "";
    const members = contents.split("@");

    for(let i in members) {
      const entry = members[i];

      if(entry.startsWith(key)) {
        return entry.substr(key.length, entry.length - key.length).trim();
      }
    }

    return "";
  },
  getNotice: function(contents) {
    const title = this.get(contents, "notice");
    return title || this.get(contents, "dev");
  }
};