From 5bb0356ef483e8e5797261a4a79bfc7fe2e768d4 Mon Sep 17 00:00:00 2001
From: John Kessenich <cepheus@frii.com>
Date: Fri, 5 Sep 2014 17:36:54 +0000
Subject: [PATCH] Add skeleton for generating documentation of a side project.

git-svn-id: https://cvs.khronos.org/svn/repos/ogl/trunk/ecosystem/public/sdk/tools/glslang@27950 e7fa87d3-cd2b-0410-9028-fcbf551c1848
---
 BIL/BilDoc.cpp     | 65 ++++++++++++++++++++++++++++++++++++++++++++++
 BIL/BilDoc.h       | 49 ++++++++++++++++++++++++++++++++++
 BIL/CMakeLists.txt |  6 +++--
 3 files changed, 118 insertions(+), 2 deletions(-)
 create mode 100644 BIL/BilDoc.cpp
 create mode 100644 BIL/BilDoc.h

diff --git a/BIL/BilDoc.cpp b/BIL/BilDoc.cpp
new file mode 100644
index 00000000..036a6cd7
--- /dev/null
+++ b/BIL/BilDoc.cpp
@@ -0,0 +1,65 @@
+//
+//Copyright (C) 2014 LunarG, Inc.
+//
+//All rights reserved.
+//
+//Redistribution and use in source and binary forms, with or without
+//modification, are permitted provided that the following conditions
+//are met:
+//
+//    Redistributions of source code must retain the above copyright
+//    notice, this list of conditions and the following disclaimer.
+//
+//    Redistributions in binary form must reproduce the above
+//    copyright notice, this list of conditions and the following
+//    disclaimer in the documentation and/or other materials provided
+//    with the distribution.
+//
+//    Neither the name of 3Dlabs Inc. Ltd. nor the names of its
+//    contributors may be used to endorse or promote products derived
+//    from this software without specific prior written permission.
+//
+//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+//"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+//LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+//FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+//COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+//INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+//BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+//LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+//CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+//LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+//ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+//POSSIBILITY OF SUCH DAMAGE.
+
+//
+// Author: John Kessenich, LunarG
+//
+
+//
+// Create BIL documentation.
+//
+
+#include "BilDoc.h"
+
+#if ! defined(INCLUDE_BIL_DOC)
+
+namespace glbil {
+
+    void PrintDoc()
+    {
+    }
+
+}; // end glbil namespace
+
+#else
+
+namespace glbil {
+
+void PrintDoc()
+{
+}
+
+}; // end glbil namespace
+
+#endif
diff --git a/BIL/BilDoc.h b/BIL/BilDoc.h
new file mode 100644
index 00000000..4e3e7875
--- /dev/null
+++ b/BIL/BilDoc.h
@@ -0,0 +1,49 @@
+//
+//Copyright (C) 2014 LunarG, Inc.
+//
+//All rights reserved.
+//
+//Redistribution and use in source and binary forms, with or without
+//modification, are permitted provided that the following conditions
+//are met:
+//
+//    Redistributions of source code must retain the above copyright
+//    notice, this list of conditions and the following disclaimer.
+//
+//    Redistributions in binary form must reproduce the above
+//    copyright notice, this list of conditions and the following
+//    disclaimer in the documentation and/or other materials provided
+//    with the distribution.
+//
+//    Neither the name of 3Dlabs Inc. Ltd. nor the names of its
+//    contributors may be used to endorse or promote products derived
+//    from this software without specific prior written permission.
+//
+//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+//"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+//LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+//FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+//COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+//INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+//BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+//LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+//CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+//LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+//ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+//POSSIBILITY OF SUCH DAMAGE.
+
+//
+// Author: John Kessenich, LunarG
+//
+
+//
+// Create BIL documentation.
+//
+
+//#define INCLUDE_BIL_DOC
+
+namespace glbil {
+
+    void PrintDoc();
+
+};  // end glbil namespace
diff --git a/BIL/CMakeLists.txt b/BIL/CMakeLists.txt
index a6b4251c..676a83cc 100644
--- a/BIL/CMakeLists.txt
+++ b/BIL/CMakeLists.txt
@@ -5,13 +5,15 @@ include_directories(.. ${CMAKE_CURRENT_BINARY_DIR})
 set(SOURCES
     GlslangToBil.cpp
     BilBuilder.cpp
-    BilDisassemble.cpp)
+    BilDisassemble.cpp
+    BilDoc.cpp)
 
 set(HEADERS
     GlslangToBil.h
     BilBuilder.h
     Bir.h
-    BilDisassemble.h)
+    BilDisassemble.h
+    BilDoc.h)
 
 add_library(BIL STATIC ${SOURCES} ${HEADERS})