Merge pull request #57 from mhaberler/asciidoc-support

Asciidoc support

Author: ArcEye

Makefile

@@ -40,6 +40,11 @@ CXXGEN   := $(BUILDDIR)/cpp
 PYGEN    := $(BUILDDIR)/python
 
 # generated Documentation files
+DOCFORMAT := asciidoc
+DOCEXT := asciidoc
+#DOCFORMAT := markdown
+#DOCEXT := md
+
 DOCGEN := $(BUILDDIR)/doc
 
 # pkg-config
@@ -73,7 +78,7 @@ PROTO_CXX_INCS := ${PROTO_SPECS:$(SRCDIR)/%.proto=$(CXXGEN)/%.pb.h}
 PROTO_CXX_SRCS  :=  ${PROTO_SPECS:$(SRCDIR)/%.proto=$(CXXGEN)/%.pb.cc}
 
 # generated doc file
-DOC_TARGET := $(DOCGEN)/machinetalk-protobuf.md
+DOC_TARGET := $(DOCGEN)/machinetalk-protobuf.$(DOCEXT)
 
 # ---- generate dependcy files for .proto files
 #
@@ -149,16 +154,16 @@ Makefile: $(GENERATED) $(PROTO_DEPS)
 #
 # see https://github.com/estan/protoc-gen-doc
 #
-# generate Markdown files from proto files
-$(DOC_TARGET): $(wildcard $(SRCDIR)/*.proto)
+# generate $(DOCFORMAT) files from proto files
+$(DOC_TARGET): $(wildcard $(SRCDIR)/*.proto) scripts/$(DOCFORMAT).mustache
 #doc_base:
 	$(ECHO) "protoc create $@ from *.proto"
 	@mkdir -p $(DOCGEN)
 	$(Q)cd $(SRCDIR); \
 	$(PROTOC) $(PROTOC_FLAGS) \
 	--proto_path=./ \
 	--proto_path=$(GPBINCLUDE)/ \
-	--doc_out=$(SRCDIRINV)/scripts/markdown.mustache,$(SRCDIRINV)/$@:./ \
+	--doc_out=$(SRCDIRINV)/scripts/$(DOCFORMAT).mustache,$(SRCDIRINV)/$@:./ \
 	$(NAMESPACEDIR)/*.proto
 
 all: $(GENERATED) $(PROTO_DEPS)

scripts/asciidoc.mustache

@@ -0,0 +1,56 @@
+# Asciidoc Protocol Documentation
+<a name="top"/>
+
+## Table of Contents
+{{#files}}
+* [{{file_name}}](#{{file_name}})
+ {{#file_messages}}
+ * [{{message_long_name}}](#{{message_full_name}})
+ {{/file_messages}}
+ {{#file_enums}}
+ * [{{enum_long_name}}](#{{enum_full_name}})
+ {{/file_enums}}
+{{/files}}
+* [Scalar Value Types](#scalar-value-types)
+
+{{#files}}
+<a name="{{file_name}}"/>
+<p align="right"><a href="#top">Top</a></p>
+
+## {{file_name}}
+
+{{#file_messages}}
+<a name="{{message_full_name}}"/>
+### {{message_long_name}}
+{{message_description}}
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+{{#message_fields}}
+| <a name="{{message_full_name}}.{{field_name}}"/> {{field_name}} | [{{field_long_type}}](#{{field_full_type}}) | {{field_label}} | {{#nobr}}{{field_description}}{{/nobr}} |
+{{/message_fields}}
+
+{{/file_messages}}
+
+{{#file_enums}}
+<a name="{{enum_full_name}}"/>
+### {{enum_long_name}}
+{{enum_description}}
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+{{#enum_values}}
+| {{value_name}} | {{value_number}} | {{#nobr}}{{value_description}}{{/nobr}} |
+{{/enum_values}}
+
+{{/file_enums}}
+{{/files}}
+
+<a name="scalar-value-types"/>
+## Scalar Value Types
+
+| .proto Type | Notes | C++ Type | Java Type | Python Type |
+| ----------- | ----- | -------- | --------- | ----------- |
+{{#scalar_value_types}}
+| <a name="{{scalar_value_proto_type}}"/> {{scalar_value_proto_type}} | {{scalar_value_notes}} | {{scalar_value_cpp_type}} | {{scalar_value_java_type}} | {{scalar_value_python_type}} |
+{{/scalar_value_types}}