diff options
-rw-r--r-- | Makefile.am | 5 | ||||
-rw-r--r-- | configure.ac | 1 | ||||
-rw-r--r-- | doc/Doxyfile.in (renamed from Doxyfile) | 20 | ||||
-rw-r--r-- | doc/Makefile | 2 | ||||
-rw-r--r-- | doc/mainpage.dox | 23 |
5 files changed, 43 insertions, 8 deletions
diff --git a/Makefile.am b/Makefile.am index d63f35e..339e67d 100644 --- a/Makefile.am +++ b/Makefile.am @@ -3,6 +3,11 @@ SUBDIRS = hangul data test pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA = libhangul.pc +EXTRA_DIST = \ + doc/Makefile \ + doc/Doxyfile.in \ + doc/mainpage.dox + log: unset LC_ALL; \ export LANG=C ; \ diff --git a/configure.ac b/configure.ac index 351be57..1aaa0c1 100644 --- a/configure.ac +++ b/configure.ac @@ -54,6 +54,7 @@ hangul/Makefile data/Makefile data/hanja/Makefile test/Makefile +doc/Doxyfile libhangul.pc ]) diff --git a/Doxyfile b/doc/Doxyfile.in index 306f411..e777b60 100644 --- a/Doxyfile +++ b/doc/Doxyfile.in @@ -17,20 +17,20 @@ # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. -PROJECT_NAME = libhangul +PROJECT_NAME = @PACKAGE_NAME@ # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = +PROJECT_NUMBER = "Version @VERSION@" # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. -OUTPUT_DIRECTORY = doc +OUTPUT_DIRECTORY = # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output @@ -193,7 +193,7 @@ ALIASES = # For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. -OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources # only. Doxygen will then generate output that is more tailored for Java. @@ -235,7 +235,7 @@ EXTRACT_STATIC = NO # defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. -EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_CLASSES = NO # This flag is only useful for Objective-C code. When set to YES local # methods, which are defined in the implementation section but not in @@ -450,7 +450,11 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = hangul +INPUT = ../hangul/hangul.h \ + ../hangul/hangulctype.c \ + ../hangul/hangulinputcontext.c \ + ../hangul/hanja.c \ + mainpage.dox # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp @@ -592,7 +596,7 @@ VERBATIM_HEADERS = YES # of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. -ALPHABETICAL_INDEX = NO +ALPHABETICAL_INDEX = YES # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns @@ -726,7 +730,7 @@ TREEVIEW_WIDTH = 250 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. -GENERATE_LATEX = YES +GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..49ded56 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,2 @@ +doc: + doxygen diff --git a/doc/mainpage.dox b/doc/mainpage.dox new file mode 100644 index 0000000..f63b8db --- /dev/null +++ b/doc/mainpage.dox @@ -0,0 +1,23 @@ +/** + +@mainpage + +@section introduction libhangul 소개 +libhangul은 기본적인 한글 관련 루틴들을 구현한 라이브러리다. +주로 한글 입력기능을 구현한 것으로 이 라이브러리를 사용하면 비교적 손쉽게 +한글 입력기를 구현할 수 있다. 현재 많은 linux의 입력기들이 이 라이브러리로 +구현되어 있다. + +@section documentation 개발 문서 +libhangul에서 제공하는 기능들은 다음 레퍼런스에서 찾아볼 수 있다. +@li @ref hangulctype : 유니코드에서 한글 글자를 구분하고 조작하는 함수들이다. +이 함수들을 이용하면 자모 코드를 음절로 조합할 수 있고 또 음절을 자모 코드로 분리할 수 있다. +@li @ref hangulicusage : 한글 입력 기능을 제공한다. 이 함수들을 이용하여 키 입력에 따른 한글 조합 기능을 손쉽게 구현할 수 있다. +@li @ref hanjadictionaryusage : 한자 사전 파일 관련 기능을 제공한다. 이 함수들을 이용하여 libhangul에서 제공하는 한자 사전 파일을 찾아볼 수 있다. + +@section website 웹주소 +libhangul은 <a href="http://kldp.net/">KLDP.net</a>에서 호스팅 되고 있다. + @li Home page: http://hangul.kldp.net/ + @li Project page: http://kldp.net/projects/hangul/ + + */ |