Merge pull request #46 from bab2min/documentation

Documentation

include/kiwi/BitEncoder.hpp

@@ -1,4 +1,4 @@
-#pragma once
+#pragma once
 
 #include <vector>
 #include <array>

include/kiwi/BitUtils.h

@@ -1,4 +1,4 @@
-#pragma once
+#pragma once
 #include <cstdint>
 
 #if defined(__SSE2__) || defined(__AVX2__)

include/kiwi/FixedVector.hpp

@@ -1,4 +1,4 @@
-#pragma once
+#pragma once
 #include <memory>
 
 namespace kiwi

include/kiwi/Form.h

@@ -1,4 +1,4 @@
-/**
+/**
  * @file Form.h
  * @author bab2min ([email protected])
  * @brief 형태 및 형태소에 관한 정보를 담는 구조체들이 선언된 헤더

include/kiwi/FrozenTrie.h

@@ -1,4 +1,4 @@
-#pragma once
+#pragma once
 
 #include <array>
 #include <vector>

include/kiwi/Kiwi.h

@@ -1,4 +1,4 @@
-/**
+/**
  * @file Kiwi.h
  * @author bab2min ([email protected])
  * @brief Kiwi C++ API를 담고 있는 헤더 파일
@@ -11,6 +11,7 @@
 
 #include <iostream>
 #include <future>
+#include "Macro.h"
 #include "Types.h"
 #include "Form.h"
 #include "Utils.h"

include/kiwi/Knlm.h

@@ -1,4 +1,4 @@
-#pragma once
+#pragma once
 
 #include <array>
 #include <vector>

include/kiwi/Macro.h

@@ -0,0 +1,10 @@
+#pragma once
+
+#define KIWI_STR_HELPER(x) #x
+#define KIWI_STR(x) KIWI_STR_HELPER(x)
+
+#define KIWI_VERSION_MAJOR 0
+#define KIWI_VERSION_MINOR 10
+#define KIWI_VERSION_PATCH 1
+
+#define KIWI_VERSION_STRING KIWI_STR(KIWI_VERSION_MAJOR) "." KIWI_STR(KIWI_VERSION_MINOR) "." KIWI_STR(KIWI_VERSION_PATCH)

include/kiwi/Mmap.h

@@ -1,4 +1,4 @@
-#pragma once
+#pragma once
 #include <string>
 #include <iostream>
 

include/kiwi/PatternMatcher.h

@@ -1,4 +1,4 @@
-#pragma once
+#pragma once
 
 #include <vector>
 #include <string>

include/kiwi/ThreadPool.h

@@ -1,4 +1,4 @@
-#pragma once
+#pragma once
 
 /*
 A simple C++11 Thread Pool implementation(https://github.com/progschj/ThreadPool)

include/kiwi/Trainer.h

@@ -1 +1 @@
-#pragma once
+#pragma once

include/kiwi/Trie.hpp

@@ -1,4 +1,4 @@
-#pragma once
+#pragma once
 #include <vector>
 #include <map>
 #include <unordered_map>

include/kiwi/Types.h

@@ -1,4 +1,4 @@
-/**
+/**
  * @file Types.h
  * @author bab2min ([email protected])
  * @brief Kiwi C++ API에 쓰이는 주요 타입들을 모아놓은 헤더 파일

include/kiwi/Utils.h

@@ -1,4 +1,4 @@
-#pragma once
+#pragma once
 #include <iostream>
 #include <string>
 #include <memory>

include/kiwi/WordDetector.h

@@ -1,4 +1,4 @@
-#pragma once
+#pragma once
 
 #include <kiwi/Types.h>
 

include/kiwi/capi.h

@@ -1,4 +1,4 @@
-/**
+/**
  * @file capi.h
  * @author bab2min ([email protected])
  * @brief Kiwi C API를 담고 있는 헤더 파일
@@ -10,6 +10,8 @@
 
 #pragma once
 
+#include "Macro.h"
+
 #define KIWIERR_FAIL -1
 #define KIWIERR_INVALID_HANDLE -2
 #define KIWIERR_INVALID_INDEX -3

kiwi_shared_library.vcxproj

@@ -34,6 +34,7 @@
     <ClInclude Include="include\kiwi\FrozenTrie.h" />
     <ClInclude Include="include\kiwi\Kiwi.h" />
     <ClInclude Include="include\kiwi\Knlm.h" />
+    <ClInclude Include="include\kiwi\Macro.h" />
     <ClInclude Include="include\kiwi\Mmap.h" />
     <ClInclude Include="include\kiwi\PatternMatcher.h" />
     <ClInclude Include="include\kiwi\ThreadPool.h" />

kiwi_shared_library.vcxproj.filters

@@ -87,6 +87,9 @@
     <ClInclude Include="include\kiwi\BitUtils.h">
       <Filter>Header Files\kiwi</Filter>
     </ClInclude>
+    <ClInclude Include="include\kiwi\Macro.h">
+      <Filter>Header Files\kiwi</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="src\Form.cpp">

src/capi/kiwi_c.cpp

@@ -8,8 +8,7 @@ using namespace kiwi;
 
 const char* kiwi_version()
 {
-	//return Kiwi::getVersion();
-	return nullptr;
+	return KIWI_VERSION_STRING;
 }
 
 struct ResultBuffer