big-data/hadoop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

HDFS-8745. Use Doxygen to generate documents for libhdfspp. Contributed by Haohui Mai.

Browse Source
This commit is contained in:
Haohui Mai 2015-07-09 13:47:20 -07:00 committed by James Clampffer
parent 40a1f3631d
commit 63eee296c7
4 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
BUILDING.txt
View File

@ -11,6 +11,8 @@ Requirements:
* Zlib devel (if compiling native code) * Zlib devel (if compiling native code)
* openssl devel (if compiling native hadoop-pipes and to get the best HDFS encryption performance) * openssl devel (if compiling native hadoop-pipes and to get the best HDFS encryption performance)
* Linux FUSE (Filesystem in Userspace) version 2.6 or above (if compiling fuse_dfs) * Linux FUSE (Filesystem in Userspace) version 2.6 or above (if compiling fuse_dfs)
* Jansson C XML parsing library ( if compiling libwebhdfs )
* Doxygen ( if compiling libhdfspp and generating the documents )
* Internet connection for first build (to fetch all Maven and Hadoop dependencies) * Internet connection for first build (to fetch all Maven and Hadoop dependencies)
* python (for releasedocs) * python (for releasedocs)
* bats (for shell code testing) * bats (for shell code testing)

8
hadoop-hdfs-project/hadoop-hdfs-client/src/main/native/libhdfspp/CMakeLists.txt
View File

@ -18,6 +18,7 @@
project (libhdfspp) project (libhdfspp)
find_package(Doxygen)
find_package(Protobuf REQUIRED) find_package(Protobuf REQUIRED)
find_package(Threads) find_package(Threads)
@ -33,6 +34,13 @@ if(APPLE)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -stdlib=libc++ -Wno-deprecated-declarations") set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -stdlib=libc++ -Wno-deprecated-declarations")
endif() endif()
if(DOXYGEN_FOUND)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doc/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/doc/Doxyfile @ONLY)
add_custom_target(doc ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doc/Doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating API documentation with Doxygen" VERBATIM)
endif(DOXYGEN_FOUND)
include_directories( include_directories(
include include
lib lib

16
hadoop-hdfs-project/hadoop-hdfs-client/src/main/native/libhdfspp/doc/Doxyfile.in Normal file
View File

@ -0,0 +1,16 @@
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "libhdfspp"
OUTPUT_DIRECTORY = doc
TAB_SIZE = 2
MARKDOWN_SUPPORT = YES
BUILTIN_STL_SUPPORT = YES
INPUT = @PROJECT_SOURCE_DIR@/doc/mainpage.dox \
@PROJECT_SOURCE_DIR@/include/libhdfspp \
INPUT_ENCODING = UTF-8
RECURSIVE = NO
GENERATE_HTML = YES
GENERATE_LATEX = NO

8
hadoop-hdfs-project/hadoop-hdfs-client/src/main/native/libhdfspp/doc/mainpage.dox Normal file
View File

@ -0,0 +1,8 @@
/**
\mainpage libhdfs++
libhdfs++ is a modern implementation of HDFS client in C++11. It is
optimized for the Massive Parallel Processing (MPP) applications that
access thousands of files concurrently in HDFS.
*/