Skip to content
This repository has been archived by the owner on Jan 7, 2022. It is now read-only.

Commit

Permalink
Generate Client API Doxygen documentation in OSS docs target (#44)
Browse files Browse the repository at this point in the history
Summary:
Put the config files used for generating the LogDevice Client API doxygen
documentation under source control. The following, limited amendments
have been made:

* Files renamed and re-located so that in code paths are relative to top
of LogDevice source tree
* Doxyfile standard downgraded from 1.8.14 to 1.8.13; as delivered with
Ubuntu Bionic, the primary supported distrib. (i.e. doxygen -ui filename)
* Corrected typo in footer as per issue #36
Pull Request resolved: #44

Differential Revision: D10297560

Pulled By: calebmarchent

fbshipit-source-id: c22262754c057ce6b648aed5bf73359447c77a46
  • Loading branch information
Caleb Marchent authored and facebook-github-bot committed Oct 10, 2018
1 parent c2c0c1e commit 67faf0b
Show file tree
Hide file tree
Showing 4 changed files with 2,526 additions and 1 deletion.
6 changes: 5 additions & 1 deletion logdevice/CMake/build-docs.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,9 @@ add_custom_target(ldquery.md
WORKING_DIRECTORY ${LOGDEVICE_DIR}/../docs
DEPENDS markdown-ldquery)

add_custom_target(client-api-doxy
COMMAND rm -rf website/static/api && doxygen logdevice/build_tools/Doxyfile.client-api
WORKING_DIRECTORY ${LOGDEVICE_DIR}/..)

add_custom_target(docs)
add_dependencies(docs settings.md ldquery.md)
add_dependencies(docs settings.md ldquery.md client-api-doxy)
Loading

0 comments on commit 67faf0b

Please sign in to comment.