No OneTemporary
Actions

Authored By

Unknown

Size

1 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/Doxy.conf b/Doxy.conf
	new file mode 100644
	index 0000000..7e32752
	--- /dev/null
	+++ b/Doxy.conf
	@@ -0,0 +1,14 @@
	+OUTPUT_DIRECTORY = ./docs/src_docs
	+EXTRACT_ALL = yes
	+EXTRACT_PRIVATE = yes
	+EXTRACT_STATIC = yes
	+
	+HAVE_DOT = yes
	+CLASS_DIAGRAMS = yes
	+CALL_GRAPH = yes
	+
	+RECURSIVE = yes
	+INPUT = ./src
	+#common formats like .c/.cc/.cxx/.c++/.cpp/.inl/.h/.hpp
	+#FILE_PATTERNS = .c .h
	+RECURSIVE = yes
	diff --git a/docs/Readme.md b/docs/Readme.md
	index 7df014f..e9931bc 100644
	--- a/docs/Readme.md
	+++ b/docs/Readme.md
	@@ -1,7 +1,16 @@
	# Project Documents

	# Build guides:

	- `build_guide-en/build_guide_for_origin.md`: Original build guide on [https://soramimi.github.io/Guitar/build-en.html]

	- `build_guide-en/build_guide_for_linux-en.md`: Simple build guide for Linux.
	+
	+# Source code documents:
	+
	+- Generate source code documents with `doxygen`:
	+
	+ cd ${YOUR_DIR}/Guitar
	+ ./generate_src_docs.sh
	+
	+- Then you'll get a folder at `${YOUR_DIR}/Guitar/docs/src_docs` for source code documents.
	diff --git a/generate_src_docs.sh b/generate_src_docs.sh
	new file mode 100755
	index 0000000..c0058c6
	--- /dev/null
	+++ b/generate_src_docs.sh
	@@ -0,0 +1,2 @@
	+#!/bin/bash
	+doxygen ./Doxy.conf