Support doxygen file from java sources.

index.js

@@ -35,7 +35,7 @@ module.exports = {
  'enum',
  // 'enumvalue',
  'func',
- // 'variable',
+ 'var',
  'property',
  'public-attrib',
  'public-func',
@@ -51,7 +51,7 @@ module.exports = {
  'class',
  'struct',
  'union',
- 'typedef',
+ 'typedef'
  // 'file'
  ]
  }
@@ -70,6 +70,18 @@ module.exports = {
  if (options.templates == this.defaultOptions.templates)
  options.templates = path.join(__dirname, 'templates', options.language);
 
+ switch(options.language) {
+ case 'java':
+ options.filters.compounds.push('interface');
+ options.filters.compounds.push('enum');
+ options.filters.members.splice(1,1);
+ options.filters.members.push('public-static-attrib');
+ options.filters.members.push('public-static-func');
+ break;
+ default:
+ break;
+ }
+
  // Load templates
  templates.registerHelpers(options);
  templates.load(options.templates);

package.json

@@ -1,6 +1,6 @@
 {
  "name": "moxygen",
- "version": "0.8.0",
+ "version": "0.8.1",
  "description": "Doxygen XML to Markdown documentation converter",
  "main": "index.js",
  "scripts": {

src/helpers.js

@@ -25,7 +25,7 @@ module.exports = {
  var link = f.match(/\[(.*)\]\((.*)\)/);
  if (link) {
  isInline ? (s += '`') && (isInline = false) : null;
- s += '[`' + link[1] + '`](' + link[2] + ')';
+ s += ' [`' + link[1] + '`](' + link[2] + ')';
  }
  }
  else if (f == '\n' || f == ' \n') {
@@ -83,7 +83,11 @@ module.exports = {
  return '#' + refid;
  return this.compoundPath(ref, options) + '#' + refid;
  } else if (options.classes) {
- var dest = this.findParent(ref, ['namespace', 'class', 'struct']);
+ var filtered = ['namespace', 'class', 'struct'];
+ if (options.language == 'java') {
+ filtered.concat(['interface', 'enum']);
+ }
+ var dest = this.findParent(ref, filtered);
  if (!dest || compound.refid == dest.refid)
  return '#' + refid;
  return this.compoundPath(dest, options) + '#' + refid;
@@ -109,7 +113,9 @@ module.exports = {
 
  writeCompound: function(compound, contents, references, options) {
  this.writeFile(this.compoundPath(compound, options), contents.map(function(content) {
- return this.resolveRefs(content, compound, references, options);
+ if (content) {
+ return this.resolveRefs(content, compound, references, options);
+ }
  }.bind(this)));
  },
 

src/parser.js

@@ -278,6 +278,7 @@ module.exports = {
  m = m.concat(toMarkdown(memberdef.type), ' ');
  // m = m.concat(memberdef.name[0]._);
  m = m.concat(markdown.refLink(member.name, member.refid));
+ m = m.concat(memberdef.initializer ? memberdef.initializer[0]._ : '');
  break;
 
  case 'property':
@@ -351,6 +352,10 @@ module.exports = {
  });
  },
 
+ assignToClass: function(compound, child) {
+ compound.compounds[child.id] = child;
+ },
+
  extractPageSections: function(page, elements) {
  elements.forEach(function(element) {
  if (element['#name'] == 'sect1' || element['#name'] == 'sect2' || element['#name'] == 'sect3') {
@@ -427,6 +432,8 @@ module.exports = {
  case 'struct':
  case 'union':
  case 'typedef':
+ case 'interface':
+ case 'enum':
 
  // set namespace reference
  var nsp = compound.name.split('::');
@@ -450,30 +457,14 @@ module.exports = {
  compound.groupname = compound.name;
  }
 
- // handle innerclass for groups and namespaces
- if (compounddef.innerclass) {
- compounddef.innerclass.forEach(function (innerclassdef) {
- if (compound.kind == 'namespace') {
- // log.verbose('Assign ' + innerclassdef.$.refid + ' to namespace ' + compound.name);
-
- if (this.references[innerclassdef.$.refid])
- this.assignToNamespace(compound, this.references[innerclassdef.$.refid]);
- }
- else if (compound.kind == 'group') {
- // log.verbose('Assign ' + innerclassdef.$.refid + ' to group ' + compound.name);
- if (this.references[innerclassdef.$.refid])
- this.assignClassToGroup(compound, this.references[innerclassdef.$.refid]);
- }
- }.bind(this));
- }
-
  // handle innernamespace for groups and namespaces
  if (compounddef.innernamespace) {
  compound.innernamespaces = [];
  compounddef.innernamespace.forEach(function (namespacedef) {
  if (compound.kind == 'group') {
  // log.verbose('Assign namespace ' + namespacedef.$.refid + ' to group ' + compound.name);
- this.assignNamespaceToGroup(compound, this.references[namespacedef.$.refid]);
+ if (this.references[namespacedef.$.refid])
+ this.assignNamespaceToGroup(compound, this.references[namespacedef.$.refid]);
  }
  }.bind(this));
  }
@@ -482,6 +473,35 @@ module.exports = {
  console.assert(true);
  }
 
+ switch(compound.kind) {
+ case 'class':
+ case 'interface':
+ case 'enum':
+ case 'namespace':
+ case 'group':
+ // handle innerclass for groups and namespaces and 'class'.
+ if (compounddef.innerclass) {
+ compounddef.innerclass.forEach(function (innerclassdef) {
+ if (compound.kind == 'namespace') {
+ // log.verbose('Assign ' + innerclassdef.$.refid + ' to namespace ' + compound.name);
+
+ if (this.references[innerclassdef.$.refid])
+ this.assignToNamespace(compound, this.references[innerclassdef.$.refid]);
+ } else if (compound.kind == 'group') {
+ // log.verbose('Assign ' + innerclassdef.$.refid + ' to group ' + compound.name);
+ if (this.references[innerclassdef.$.refid])
+ this.assignClassToGroup(compound, this.references[innerclassdef.$.refid]);
+ } else if (compound.kind == 'class' || compound.kind == 'interface' || compound.kind == 'enum') {
+ if (this.references[innerclassdef.$.refid])
+ this.assignToClass(compound, this.references[innerclassdef.$.refid]);
+ }
+ }.bind(this));
+ }
+ break;
+ default:
+ break;
+ }
+
  return;
  },
 
@@ -526,7 +546,9 @@ module.exports = {
  return;
  }
  this.root.kind = 'index';
- this.parseIndex(this.root, result.doxygenindex.compound, options);
+ this.parseIndex(this.root, result.doxygenindex.compound.sort(function(a, b){
+ return b.$.refid.length - a.$.refid.length;
+ }), options);
  callback(null, this.root); // TODO: return errors properly
  }.bind(this));
  }.bind(this));

src/templates.js

@@ -55,6 +55,8 @@ module.exports = {
  break;
  case 'class':
  case 'struct':
+ case 'interface':
+ case 'enum':
  template = 'class';
  break;
  default:

templates/java/class.md

@@ -0,0 +1,48 @@
+# {{kind}} `{{name}}` {{anchor refid}}
+
+{{#if basecompoundref}}
+```
+{{kind}} {{name}}
+ {{#each basecompoundref}}
+ : {{prot}} {{name}}
+ {{/each}}
+``` 
+{{/if}}
+
+{{briefdescription}}
+
+{{detaileddescription}}
+
+## Summary
+
+ Members | Descriptions 
+--------------------------------|---------------------------------------------
+{{#each filtered.compounds}}{{cell proto}} | {{cell summary}}
+{{/each}}{{#each filtered.members}}{{cell proto}} | {{cell summary}}
+{{/each}}
+
+## Members
+
+{{#each filtered.compounds}}
+#### {{title proto}} {{anchor refid}}
+
+{{briefdescription}}
+
+{{detaileddescription}}
+{{/each}}
+
+{{#each filtered.members}}
+#### {{title proto}} {{anchor refid}}
+
+{{#if enumvalue}}
+ Values | Descriptions 
+--------------------------------|---------------------------------------------
+{{#each enumvalue}}{{cell name}} | {{cell summary}}
+{{/each}}
+{{/if}}
+
+{{briefdescription}}
+
+{{detaileddescription}}
+
+{{/each}}

templates/java/index.md

@@ -0,0 +1,27 @@
+# Summary
+
+ Members | Descriptions 
+--------------------------------|---------------------------------------------
+{{#each filtered.members}}{{cell proto}} | {{cell summary}}
+{{/each}}{{#each filtered.compounds}}{{cell proto}} | {{cell summary}}
+{{/each}}
+
+{{#if filtered.members}}
+## Members
+
+{{#each filtered.members}}
+#### {{title proto}} {{anchor refid}}
+
+{{briefdescription}}
+
+{{#if enumvalue}}
+ Values | Descriptions 
+--------------------------------|---------------------------------------------
+{{#each enumvalue}}{{cell name}} | {{cell summary}}
+{{/each}}
+{{/if}}
+
+{{detaileddescription}}
+
+{{/each}}
+{{/if}}

templates/java/namespace.md

@@ -0,0 +1,33 @@
+# {{kind}} `{{name}}` {{anchor refid}}
+
+{{briefdescription}}
+
+{{detaileddescription}}
+
+## Summary
+
+ Members | Descriptions 
+--------------------------------|---------------------------------------------
+{{#each filtered.members}}{{cell proto}} | {{cell summary}}
+{{/each}}{{#each filtered.compounds}}{{cell proto}} | {{cell summary}}
+{{/each}}
+
+{{#if filtered.members}}
+## Members
+
+{{#each filtered.members}}
+#### {{title proto}} {{anchor refid}}
+
+{{#if enumvalue}}
+ Values | Descriptions 
+--------------------------------|---------------------------------------------
+{{#each enumvalue}}{{cell name}} | {{cell summary}}
+{{/each}}
+{{/if}}
+
+{{briefdescription}}
+
+{{detaileddescription}}
+
+{{/each}}
+{{/if}}

templates/java/page.md

@@ -0,0 +1,34 @@
+# {{kind}} `{{name}}` {{anchor refid}}
+
+{{briefdescription}}
+
+{{detaileddescription}}
+
+{{#if filtered.members}}
+
+## Summary
+
+ Members | Descriptions 
+--------------------------------|---------------------------------------------
+{{#each filtered.members}}{{cell proto}} | {{cell summary}}
+{{/each}}{{#each filtered.compounds}}{{cell proto}} | {{cell summary}}
+{{/each}}
+
+## Members
+
+{{#each filtered.members}}
+#### {{title proto}} {{anchor refid}}
+
+{{#if enumvalue}}
+ Values | Descriptions 
+--------------------------------|---------------------------------------------
+{{#each enumvalue}}{{cell name}} | {{cell summary}}
+{{/each}}
+{{/if}}
+
+{{briefdescription}}
+
+{{detaileddescription}}
+
+{{/each}}
+{{/if}}