Markdown output

README.md

@@ -1,8 +1,7 @@
-[![Build Status](https://travis-ci.org/jessevdk/cldoc.svg?branch=master)](https://travis-ci.org/jessevdk/cldoc)
-
-cldoc is a clang based documentation generator for C and C++. cldoc tries to
+markdoc is a fork of cldoc, a clang based documentation generator for C and C++. cldoc tries to
 solve the issue of writing C/C++ software documentation with a modern,
 non-intrusive and robust approach.
+markdoc produces markdown _output_ intended for jekyll-based static sites such as GitHub pages.
 
 # Features
 * Uses clang to robustly parse even the most complex C++ projects without

cldoc.pyproj

@@ -0,0 +1,128 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" DefaultTargets="Build">
+  <PropertyGroup>
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <SchemaVersion>2.0</SchemaVersion>
+    <ProjectGuid>{91ab4796-69d9-421c-b7a7-544a473f214b}</ProjectGuid>
+    <ProjectHome />
+    <StartupFile>scripts\test.py</StartupFile>
+    <SearchPath>..\..\..\..\..\Python36;..\..\..\..\..\Python36\Scripts</SearchPath>
+    <WorkingDirectory>.</WorkingDirectory>
+    <OutputPath>.</OutputPath>
+    <ProjectTypeGuids>{888888a0-9f3d-457c-b088-3a5042f75d52}</ProjectTypeGuids>
+    <LaunchProvider>Standard Python launcher</LaunchProvider>
+    <CommandLineArguments>generate -IC:\\Simul\\4.2 -I"$(VCINSTALLDIR)\\atlmfc\\include" -I"$(VCINSTALLDIR)\\include" -I"C:\\Program Files (x86)\\Windows Kits\\10\\Include\\10.0.10240.0\\ucrt" -I"C:\\Program Files\\LLVM\\lib\\clang\\6.0.0\\include" -std=c++1y -fms-extensions -fms-compatibility -fms-compatibility-version=19 -Wno-deprecated-declarations -Wno-ignored-attributes -Wno-microsoft-template -D_MSC_VER=1900 -DDOXYGEN=1 -- --type=md --loglevel=info --output C:/Simul/docs --strip "$(SIMUL)/" --md_output ref $(SIMUL)/Base/*.h $(SIMUL)/Clouds/*.h $(SIMUL)/Sky/*.h $(SIMUL)/Terrain/*.h --merge "C:/Simul/4.2/Simul/Help/*.md" --clean C:/Simul/docs/ref --post "$(SIMUL)/Help/build.bat"</CommandLineArguments>
+    <InterpreterPath>
+    </InterpreterPath>
+    <EnableNativeCodeDebugging>False</EnableNativeCodeDebugging>
+    <Environment>Path=C:\Program Files\LLVM\bin;$(Path)
+also=	
+test= 
+
+</Environment>
+    <IsWindowsApplication>False</IsWindowsApplication>
+    <InterpreterId>Global|PythonCore|3.7</InterpreterId>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)' == 'Debug'" />
+  <PropertyGroup Condition="'$(Configuration)' == 'Release'" />
+  <PropertyGroup>
+    <VisualStudioVersion Condition=" '$(VisualStudioVersion)' == '' ">10.0</VisualStudioVersion>
+  </PropertyGroup>
+  <ItemGroup>
+    <Compile Include="cldoc\clang\cindex.py" />
+    <Compile Include="cldoc\clang\enumerations.py" />
+    <Compile Include="cldoc\clang\__init__.py" />
+    <Compile Include="cldoc\cmdgenerate.py" />
+    <Compile Include="cldoc\comment.py" />
+    <Compile Include="cldoc\defdict.py" />
+    <Compile Include="cldoc\documentmerger.py" />
+    <Compile Include="cldoc\example.py" />
+    <Compile Include="cldoc\fs.py" />
+    <Compile Include="cldoc\generators\generator.py" />
+    <Compile Include="cldoc\generators\md.py">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="cldoc\generators\__init__.py" />
+    <Compile Include="cldoc\includepaths.py" />
+    <Compile Include="cldoc\log.py" />
+    <Compile Include="cldoc\nodes\category.py" />
+    <Compile Include="cldoc\nodes\cclass.py" />
+    <Compile Include="cldoc\nodes\classtemplate.py" />
+    <Compile Include="cldoc\nodes\constructor.py" />
+    <Compile Include="cldoc\nodes\conversionfunction.py" />
+    <Compile Include="cldoc\nodes\cstruct.py" />
+    <Compile Include="cldoc\nodes\ctype.py" />
+    <Compile Include="cldoc\nodes\destructor.py" />
+    <Compile Include="cldoc\nodes\enum.py" />
+    <Compile Include="cldoc\nodes\enumvalue.py" />
+    <Compile Include="cldoc\nodes\field.py" />
+    <Compile Include="cldoc\nodes\function.py" />
+    <Compile Include="cldoc\nodes\functiontemplate.py" />
+    <Compile Include="cldoc\nodes\method.py" />
+    <Compile Include="cldoc\nodes\namespace.py" />
+    <Compile Include="cldoc\nodes\node.py" />
+    <Compile Include="cldoc\nodes\root.py" />
+    <Compile Include="cldoc\nodes\templated.py" />
+    <Compile Include="cldoc\nodes\templatetypeparameter.py" />
+    <Compile Include="cldoc\nodes\typedef.py" />
+    <Compile Include="cldoc\nodes\union.py" />
+    <Compile Include="cldoc\nodes\variable.py" />
+    <Compile Include="cldoc\nodes\__init__.py" />
+    <Compile Include="cldoc\parser.py">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="cldoc\staticsite.py" />
+    <Compile Include="cldoc\struct.py" />
+    <Compile Include="cldoc\tree.py" />
+    <Compile Include="cldoc\utf8.py" />
+    <Compile Include="cldoc\__init__.py" />
+    <Compile Include="scripts\test.py">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="setup.py" />
+    <Compile Include="tests\regression.py" />
+  </ItemGroup>
+  <ItemGroup>
+    <Content Include="cldoc-static\lib\cldoc-static-run.js" />
+    <Content Include="cldoc-static\lib\cldoc-static.js" />
+    <Content Include="cldoc\data\index.html" />
+    <Content Include="cldoc\data\javascript\cldoc.js" />
+    <Content Include="cldoc\data\javascript\highlight.js" />
+    <Content Include="cldoc\data\javascript\jquery-1.9.1.js" />
+    <Content Include="cldoc\data\javascript\jquery-ui-1.10.0.custom.min.js" />
+    <Content Include="cldoc\data\javascript\marked.js" />
+    <Content Include="cldoc\data\styles\cldoc.css" />
+    <Content Include="example\CMakeLists.txt" />
+    <Content Include="html\index.html" />
+    <Content Include="html\javascript\highlight.js" />
+    <Content Include="html\javascript\jquery-1.9.1.js" />
+    <Content Include="html\javascript\jquery-ui-1.10.0.custom.min.js" />
+    <Content Include="html\javascript\marked.js" />
+    <Content Include="html\media\close.svg" />
+    <Content Include="html\media\search.svg" />
+    <Content Include="scripts\cldoc-dev" />
+    <Content Include="scripts\cldoc-dev.py" />
+    <Content Include="scripts\inline" />
+  </ItemGroup>
+  <ItemGroup>
+    <Folder Include="cldoc" />
+    <Folder Include="cldoc-static\" />
+    <Folder Include="cldoc-static\lib" />
+    <Folder Include="cldoc\clang" />
+    <Folder Include="cldoc\data" />
+    <Folder Include="cldoc\data\javascript" />
+    <Folder Include="cldoc\data\styles" />
+    <Folder Include="cldoc\generators" />
+    <Folder Include="cldoc\nodes" />
+    <Folder Include="example" />
+    <Folder Include="html" />
+    <Folder Include="html\javascript" />
+    <Folder Include="html\media" />
+    <Folder Include="scripts\" />
+    <Folder Include="tests" />
+  </ItemGroup>
+  <ItemGroup>
+    <InterpreterReference Include="Global|PythonCore|3.7" />
+  </ItemGroup>
+  <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\Python Tools\Microsoft.PythonTools.targets" />
+</Project>

cldoc.sln

@@ -0,0 +1,20 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio 14
+VisualStudioVersion = 14.0.25123.0
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{888888A0-9F3D-457C-B088-3A5042F75D52}") = "cldoc", "cldoc.pyproj", "{91AB4796-69D9-421C-B7A7-544A473F214B}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{91AB4796-69D9-421C-B7A7-544A473F214B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{91AB4796-69D9-421C-B7A7-544A473F214B}.Release|Any CPU.ActiveCfg = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+EndGlobal

cldoc/__init__.py

@@ -14,58 +14,39 @@
 
 import sys
 
-def run_inspect(args):
-    from . import cmdinspect
-    cmdinspect.run(args)
-
-def run_serve(args):
-    from . import cmdserve
-    cmdserve.run(args)
-
 def run_generate(args):
-    from . import cmdgenerate
-    cmdgenerate.run(args)
-
-def run_gir(args):
-    from . import cmdgir
-    cmdgir.run(args)
+	from . import cmdgenerate
+	cmdgenerate.run(args)
 
 def print_available_commands():
-    sys.stderr.write('Available commands:\n')
+	sys.stderr.write('Available commands:\n')
 
-    commands = ['inspect', 'serve', 'generate', 'gir']
+	commands = ['inspect', 'serve', 'generate', 'gir']
 
-    for c in commands:
-        sys.stderr.write('  ' + c + '\n')
+	for c in commands:
+		sys.stderr.write('  ' + c + '\n')
 
-    sys.stderr.write('\n')
+	sys.stderr.write('\n')
 
 def run():
-    if len(sys.argv) <= 1:
-        sys.stderr.write('Please use: cldoc [command] [OPTIONS] [FILES...]\n\n')
-        print_available_commands()
-        sys.exit(1)
-
-    cmd = sys.argv[1]
-    rest = sys.argv[2:]
-
-    if cmd == 'inspect':
-        run_inspect(rest)
-    elif cmd == 'serve':
-        run_serve(rest)
-    elif cmd == 'generate':
-        run_generate(rest)
-    elif cmd == 'gir':
-        run_gir(rest)
-    elif cmd == '--help' or cmd == '-h':
-        sys.stderr.write('Please use: cldoc [command] --help\n\n')
-        print_available_commands()
-        sys.exit(1)
-    else:
-        sys.stderr.write('Unknown command `{0}\'\n'.format(cmd))
-        sys.exit(1)
+	if len(sys.argv) <= 1:
+		sys.stderr.write('Please use: cldoc [command] [OPTIONS] [FILES...] or cldoc file.markdoc\n\n')
+		print_available_commands()
+		sys.exit(1)
+
+	cmd = sys.argv[1]
+	rest = sys.argv[2:]
+	if cmd == 'generate':
+		run_generate(rest)
+	elif cmd == '--help' or cmd == '-h':
+		sys.stderr.write('Please use: cldoc [command] --help\n\n')
+		print_available_commands()
+		sys.exit(1)
+	else:
+		sys.stderr.write('Unknown command `{0}\'\n'.format(cmd))
+		sys.exit(1)
 
 if __name__ == '__main__':
-    run()
+	run()
 
 # vi:ts=4:et

cldoc/clang/__init__.py

@@ -1,6 +1,6 @@
 #===- __init__.py - Clang Python Bindings --------------------*- python -*--===#
 #
-#                     The LLVM Compiler Infrastructure
+#					 The LLVM Compiler Infrastructure
 #
 # This file is distributed under the University of Illinois Open Source
 # License. See LICENSE.TXT for details.
@@ -17,7 +17,7 @@
 
   cindex
 
-    Bindings for the Clang indexing library.
+	Bindings for the Clang indexing library.
 """
 
 __all__ = ['cindex']