Skip to content

Commit 967f23b

Browse files
authored
Merge pull request #245 from ferdnyc/license-block
Upgrade Doxygen documentation formatting/content
2 parents a47d5b5 + 26090c2 commit 967f23b

File tree

163 files changed

+1220
-577
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

163 files changed

+1220
-577
lines changed

Doxyfile.in

Lines changed: 376 additions & 194 deletions
Large diffs are not rendered by default.

cmake/Modules/UseDoxygen.cmake

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -105,12 +105,18 @@ if(DOXYGEN_FOUND AND DOXYFILE_IN_FOUND)
105105
STRING "Additional source files/directories separated by space")
106106
set(DOXYFILE_SOURE_DIRS "\"${DOXYFILE_SOURCE_DIR}\" ${DOXYFILE_EXTRA_SOURCES}")
107107

108-
usedoxygen_set_default(DOXYFILE_LATEX YES BOOL "Generate LaTeX API documentation" OFF)
108+
usedoxygen_set_default(DOXYFILE_LATEX OFF BOOL "Generate LaTeX API documentation")
109109
usedoxygen_set_default(DOXYFILE_LATEX_DIR "latex" STRING "LaTex output directory")
110110

111111
mark_as_advanced(DOXYFILE_OUTPUT_DIR DOXYFILE_HTML_DIR DOXYFILE_LATEX_DIR
112112
DOXYFILE_SOURCE_DIR DOXYFILE_EXTRA_SOURCE_DIRS DOXYFILE_IN)
113113

114+
## Dot
115+
usedoxygen_set_default(DOXYFILE_USE_DOT ON BOOL "Use dot (part of graphviz) to generate graphs")
116+
set(DOXYFILE_DOT "NO")
117+
if(DOXYFILE_USE_DOT AND DOXYGEN_DOT_EXECUTABLE)
118+
set(DOXYFILE_DOT "YES")
119+
endif()
114120

115121
set_property(DIRECTORY
116122
APPEND PROPERTY
@@ -125,13 +131,12 @@ if(DOXYGEN_FOUND AND DOXYFILE_IN_FOUND)
125131

126132
## LaTeX
127133
set(DOXYFILE_PDFLATEX "NO")
128-
set(DOXYFILE_DOT "NO")
129134

130135
set_property(DIRECTORY APPEND PROPERTY
131136
ADDITIONAL_MAKE_CLEAN_FILES
132137
"${DOXYFILE_OUTPUT_DIR}/${DOXYFILE_LATEX_DIR}")
133138

134-
if(DOXYFILE_LATEX STREQUAL "ON")
139+
if(DOXYFILE_LATEX)
135140
set(DOXYFILE_GENERATE_LATEX "YES")
136141
find_package(LATEX)
137142
find_program(DOXYFILE_MAKE make)
@@ -140,9 +145,6 @@ if(DOXYGEN_FOUND AND DOXYFILE_IN_FOUND)
140145
if(PDFLATEX_COMPILER)
141146
set(DOXYFILE_PDFLATEX "YES")
142147
endif()
143-
if(DOXYGEN_DOT_EXECUTABLE)
144-
set(DOXYFILE_DOT "YES")
145-
endif()
146148

147149
add_custom_command(TARGET doxygen
148150
POST_BUILD

doc/INSTALL-LINUX.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Building libopenshot for Linux
2+
13
## Getting Started
24

35
The best way to get started with libopenshot, is to learn about our build system, obtain all the source code,
@@ -22,47 +24,47 @@ The following libraries are required to build libopenshot. Instructions on how
2224
dependencies vary for each operating system. Libraries and Executables have been labeled in the
2325
list below to help distinguish between them.
2426

25-
* ### FFmpeg (libavformat, libavcodec, libavutil, libavdevice, libavresample, libswscale)
27+
### FFmpeg (libavformat, libavcodec, libavutil, libavdevice, libavresample, libswscale)
2628
* http://www.ffmpeg.org/ `(Library)`
2729
* This library is used to decode and encode video, audio, and image files. It is also used to obtain information about media files, such as frame rate, sample rate, aspect ratio, and other common attributes.
2830

29-
* ### ImageMagick++ (libMagick++, libMagickWand, libMagickCore)
31+
### ImageMagick++ (libMagick++, libMagickWand, libMagickCore)
3032
* http://www.imagemagick.org/script/magick++.php `(Library)`
3133
* This library is **optional**, and used to decode and encode images.
3234

33-
* ### OpenShot Audio Library (libopenshot-audio)
35+
### OpenShot Audio Library (libopenshot-audio)
3436
* https://github.com/OpenShot/libopenshot-audio/ `(Library)`
3537
* This library is used to mix, resample, host plug-ins, and play audio. It is based on the JUCE project, which is an outstanding audio library used by many different applications
3638

37-
* ### Qt 5 (libqt5)
39+
### Qt 5 (libqt5)
3840
* http://www.qt.io/qt5/ `(Library)`
3941
* Qt5 is used to display video, store image data, composite images, apply image effects, and many other utility functions, such as file system manipulation, high resolution timers, etc...
4042

41-
* ### CMake (cmake)
43+
### CMake (cmake)
4244
* http://www.cmake.org/ `(Executable)`
4345
* This executable is used to automate the generation of Makefiles, check for dependencies, and is the backbone of libopenshot’s cross-platform build process.
4446

45-
* ### SWIG (swig)
47+
### SWIG (swig)
4648
* http://www.swig.org/ `(Executable)`
4749
* This executable is used to generate the Python and Ruby bindings for libopenshot. It is a simple and powerful wrapper for C++ libraries, and supports many languages.
4850

49-
* ### Python 3 (libpython)
51+
### Python 3 (libpython)
5052
* http://www.python.org/ `(Executable and Library)`
5153
* This library is used by swig to create the Python (version 3+) bindings for libopenshot. This is also the official language used by OpenShot Video Editor (a graphical interface to libopenshot).
5254

53-
* ### Doxygen (doxygen)
55+
### Doxygen (doxygen)
5456
* http://www.stack.nl/~dimitri/doxygen/ `(Executable)`
5557
* This executable is used to auto-generate the documentation used by libopenshot.
5658

57-
* ### UnitTest++ (libunittest++)
59+
### UnitTest++ (libunittest++)
5860
* https://github.com/unittest-cpp/ `(Library)`
5961
* This library is used to execute unit tests for libopenshot. It contains many macros used to keep our unit testing code very clean and simple.
6062

61-
* ### ZeroMQ (libzmq)
63+
### ZeroMQ (libzmq)
6264
* http://zeromq.org/ `(Library)`
6365
* This library is used to communicate between libopenshot and other applications (publisher / subscriber). Primarily used to send debug data from libopenshot.
6466

65-
* ### OpenMP (-fopenmp)
67+
### OpenMP (-fopenmp)
6668
* http://openmp.org/wp/ `(Compiler Flag)`
6769
* If your compiler supports this flag (GCC, Clang, and most other compilers), it provides libopenshot with easy methods of using parallel programming techniques to improve performance and take advantage of multi-core processors.
6870

@@ -99,25 +101,25 @@ git clone https://github.com/OpenShot/libopenshot-audio.git
99101

100102
The source code is divided up into the following folders.
101103

102-
* ### build/
104+
### build/
103105
* This folder needs to be manually created, and is used by cmake to store the temporary build files, such as makefiles, as well as the final binaries (library and test executables).
104106

105-
* ### cmake/
107+
### cmake/
106108
* This folder contains custom modules not included by default in cmake, used to find dependency libraries and headers and determine if these libraries are installed.
107109

108-
* ### doc/
110+
### doc/
109111
* This folder contains documentation and related files, such as logos and images required by the doxygen auto-generated documentation.
110112

111-
* ### include/
113+
### include/
112114
* This folder contains all headers (*.h) used by libopenshot.
113115

114-
* ### src/
116+
### src/
115117
* This folder contains all source code (*.cpp) used by libopenshot.
116118

117-
* ### tests/
119+
### tests/
118120
* This folder contains all unit test code. Each class has it’s own test file (*.cpp), and uses UnitTest++ macros to keep the test code simple and manageable.
119121

120-
* ### thirdparty/
122+
### thirdparty/
121123
* This folder contains code not written by the OpenShot team. For example, jsoncpp, an open-source JSON parser.
122124

123125
## Install Dependencies

doc/INSTALL-MAC.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Building libopenshot for MacOS
2+
13
## Getting Started
24

35
The best way to get started with libopenshot, is to learn about our build system, obtain all the source code,
@@ -22,47 +24,47 @@ The following libraries are required to build libopenshot. Instructions on how
2224
dependencies vary for each operating system. Libraries and Executables have been labeled in the
2325
list below to help distinguish between them.
2426

25-
* ### FFmpeg (libavformat, libavcodec, libavutil, libavdevice, libavresample, libswscale)
27+
### FFmpeg (libavformat, libavcodec, libavutil, libavdevice, libavresample, libswscale)
2628
* http://www.ffmpeg.org/ `(Library)`
2729
* This library is used to decode and encode video, audio, and image files. It is also used to obtain information about media files, such as frame rate, sample rate, aspect ratio, and other common attributes.
2830

29-
* ### ImageMagick++ (libMagick++, libMagickWand, libMagickCore)
31+
### ImageMagick++ (libMagick++, libMagickWand, libMagickCore)
3032
* http://www.imagemagick.org/script/magick++.php `(Library)`
3133
* This library is **optional**, and used to decode and encode images.
3234

33-
* ### OpenShot Audio Library (libopenshot-audio)
35+
### OpenShot Audio Library (libopenshot-audio)
3436
* https://github.com/OpenShot/libopenshot-audio/ `(Library)`
3537
* This library is used to mix, resample, host plug-ins, and play audio. It is based on the JUCE project, which is an outstanding audio library used by many different applications
3638

37-
* ### Qt 5 (libqt5)
39+
### Qt 5 (libqt5)
3840
* http://www.qt.io/qt5/ `(Library)`
3941
* Qt5 is used to display video, store image data, composite images, apply image effects, and many other utility functions, such as file system manipulation, high resolution timers, etc...
4042

41-
* ### CMake (cmake)
43+
### CMake (cmake)
4244
* http://www.cmake.org/ `(Executable)`
4345
* This executable is used to automate the generation of Makefiles, check for dependencies, and is the backbone of libopenshot’s cross-platform build process.
4446

45-
* ### SWIG (swig)
47+
### SWIG (swig)
4648
* http://www.swig.org/ `(Executable)`
4749
* This executable is used to generate the Python and Ruby bindings for libopenshot. It is a simple and powerful wrapper for C++ libraries, and supports many languages.
4850

49-
* ### Python 3 (libpython)
51+
### Python 3 (libpython)
5052
* http://www.python.org/ `(Executable and Library)`
5153
* This library is used by swig to create the Python (version 3+) bindings for libopenshot. This is also the official language used by OpenShot Video Editor (a graphical interface to libopenshot).
5254

53-
* ### Doxygen (doxygen)
55+
### Doxygen (doxygen)
5456
* http://www.stack.nl/~dimitri/doxygen/ `(Executable)`
5557
* This executable is used to auto-generate the documentation used by libopenshot.
5658

57-
* ### UnitTest++ (libunittest++)
59+
### UnitTest++ (libunittest++)
5860
* https://github.com/unittest-cpp/ `(Library)`
5961
* This library is used to execute unit tests for libopenshot. It contains many macros used to keep our unit testing code very clean and simple.
6062

61-
* ### ZeroMQ (libzmq)
63+
### ZeroMQ (libzmq)
6264
* http://zeromq.org/ `(Library)`
6365
* This library is used to communicate between libopenshot and other applications (publisher / subscriber). Primarily used to send debug data from libopenshot.
6466

65-
* ### OpenMP (-fopenmp)
67+
### OpenMP (-fopenmp)
6668
* http://openmp.org/wp/ `(Compiler Flag)`
6769
* If your compiler supports this flag (GCC, Clang, and most other compilers), it provides libopenshot with easy methods of using parallel programming techniques to improve performance and take advantage of multi-core processors.
6870

@@ -98,25 +100,25 @@ git clone https://github.com/OpenShot/libopenshot-audio.git
98100

99101
The source code is divided up into the following folders.
100102

101-
* ### build/
103+
### build/
102104
* This folder needs to be manually created, and is used by cmake to store the temporary build files, such as makefiles, as well as the final binaries (library and test executables).
103105

104-
* ### cmake/
106+
### cmake/
105107
* This folder contains custom modules not included by default in cmake, used to find dependency libraries and headers and determine if these libraries are installed.
106108

107-
* ### doc/
109+
### doc/
108110
* This folder contains documentation and related files, such as logos and images required by the doxygen auto-generated documentation.
109111

110-
* ### include/
112+
### include/
111113
* This folder contains all headers (*.h) used by libopenshot.
112114

113-
* ### src/
115+
### src/
114116
* This folder contains all source code (*.cpp) used by libopenshot.
115117

116-
* ### tests/
118+
### tests/
117119
* This folder contains all unit test code. Each class has it’s own test file (*.cpp), and uses UnitTest++ macros to keep the test code simple and manageable.
118120

119-
* ### thirdparty/
121+
### thirdparty/
120122
* This folder contains code not written by the OpenShot team. For example, jsoncpp, an open-source JSON parser.
121123

122124
## Install Dependencies

0 commit comments

Comments
 (0)