Skip to content

Commit

Permalink
Fix doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
PeterMatula committed Nov 15, 2021
1 parent f49ecb6 commit 8e8cda6
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
5 changes: 4 additions & 1 deletion doc/doxygen/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ set(DOXYGEN_WARNINGS "YES")
set(DOXYGEN_EXTRACT_PRIVATE "YES")
set(DOXYGEN_EXTRACT_LOCAL_CLASSES "YES")
set(DOXYGEN_INTERNAL_DOCS "YES")
set(DOXYGEN_EXCLUDE_PATTERNS "")
set(DOXYGEN_EXCLUDE "")
set(DOXYGEN_EXCLUDE_PATTERNS
"*/symbolic_tree_match.h" # Doxygen is not dealing with this.
)
set(DOXYGEN_EXCLUDE_SYMBOLS "")
set(DOXYGEN_ENABLED_SECTIONS "internal")
set(DOXYGEN_INCLUDE_GRAPH "NO")
Expand Down
5 changes: 3 additions & 2 deletions doc/doxygen/doxygen.cfg.in
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
## EXTRACT_LOCAL_CLASSES = @DOXYGEN_EXTRACT_LOCAL_CLASSES@
## INTERNAL_DOCS = @DOXYGEN_INTERNAL_DOCS@
## ENABLED_SECTIONS = @DOXYGEN_ENABLED_SECTIONS@
## EXCLUDE = @DOXYGEN_EXCLUDE@
## EXCLUDE_PATTERNS = @DOXYGEN_EXCLUDE_PATTERNS@
## EXCLUDE_SYMBOLS = @DOXYGEN_EXCLUDE_SYMBOLS@
## INCLUDE_GRAPH = @DOXYGEN_INCLUDE_GRAPH@
Expand Down Expand Up @@ -909,7 +910,7 @@ RECURSIVE = YES
# Note that relative paths are relative to the directory from which doxygen is
# run.

EXCLUDE =
EXCLUDE = @DOXYGEN_EXCLUDE@

# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
Expand Down Expand Up @@ -2458,7 +2459,7 @@ PLANTUML_INCLUDE_PATH =
# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.

DOT_GRAPH_MAX_NODES = 50
DOT_GRAPH_MAX_NODES = 80

# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @file src/fileinfo/fileformat/file_information_types/pe_timestamps.h
* @file include/retdec/fileformat/types/pe_timestamps/pe_timestamps.h
* @brief PE timestamps.
* @copyright (c) 2017 Avast Software, licensed under the MIT license
*/
Expand Down
11 changes: 4 additions & 7 deletions src/llvmir2hll/utils/ir.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -87,19 +87,16 @@ ShPtr<Expression> skipUnaryExpr(ShPtr<Expression> expr) {

} // anonymous namespace

namespace retdec {
namespace llvmir2hll {

/**
* @brief Sorts the given vector by the name of its elements (case-insensitively).
* @note This one function is defined outside the namespace below with explicit
* namespace declarations to help Doxygen and prevent it from generating
* "no matching file member found for" warnings.
*/
void retdec::llvmir2hll::sortByName(retdec::llvmir2hll::FuncVector &vec) {
void sortByName(FuncVector &vec) {
std::sort(vec.begin(), vec.end(), compareFuncs);
}

namespace retdec {
namespace llvmir2hll {

/**
* @brief Sorts the given vector by the name of its elements (case-insensitively).
*/
Expand Down
5 changes: 2 additions & 3 deletions src/pelib/ConfigDirectory.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@

namespace PeLib {
/**
* @param inStream Input stream.
* @param imageLoader A valid image loader reference which is necessary because some RVA calculations need to be done.
**/
* @param imageLoader A valid image loader reference which is necessary because some RVA calculations need to be done.
**/

int ConfigDirectory::read(ImageLoader& imageLoader)
{
Expand Down

0 comments on commit 8e8cda6

Please sign in to comment.