Skip to content

Commit

Permalink
Additional doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
emilydolson committed Mar 7, 2021
1 parent 8eca3ba commit 99532c0
Show file tree
Hide file tree
Showing 11 changed files with 19 additions and 18 deletions.
11 changes: 6 additions & 5 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -821,10 +821,10 @@ EXCLUDE_SYMLINKS = NO
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*

EXCLUDE_PATTERNS = */demos/*
EXCLUDE_PATTERNS += */examples/*
EXCLUDE_PATTERNS += */tests/config/*
EXCLUDE_PATTERNS += */third-party/*
EXCLUDE_PATTERNS = */demos/*
EXCLUDE_PATTERNS += */examples/*
EXCLUDE_PATTERNS += */tests/config/*
EXCLUDE_PATTERNS += */third-party/*

# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
Expand All @@ -835,7 +835,8 @@ EXCLUDE_PATTERNS += */third-party/*
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*

EXCLUDE_SYMBOLS = EMP_* EM_* internal emp::internal
EXCLUDE_SYMBOLS = EMP_*
EXCLUDE_SYMBOLS += EM_*

# The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include
Expand Down
5 changes: 2 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,8 @@ install-coverage-dependencies:
cd third-party && make install-coverage-dependencies

clean:
rm -rf doc/_build/*
rm -rf doc/api
rm -rf doc/doxyoutput
cd docs && make clean
cd tests && make clean

clean-dep:
cd third-party && make clean
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Tools in Empirical include:
* A signal-action system that allows for efficient customization of tools, and flexible
software that can easily facilitate plug-in functionality.

See [https://empirical.readthedocs.io/en/latest](https://empirical.readthedocs.io/en/latest) for more detailed documentation
See <https://empirical.readthedocs.io/en/latest> for more detailed documentation
on the available source files.

# Directory Structure
Expand Down
1 change: 1 addition & 0 deletions include/emp/datastructs/BloomFilter.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
*
* @copyright Arash Partow, 2000 (modified slightly by Emily Dolson)
* @brief A Bloom filter implementation
* @file BloomFilter.hpp
*/

/*
Expand Down
2 changes: 1 addition & 1 deletion include/emp/debug/mem_track.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ namespace emp {
}

}
#endif DOXYGEN_SHOULD_SKIP_THIS
#endif // DOXYGEN_SHOULD_SKIP_THIS

}
#endif
Expand Down
2 changes: 1 addition & 1 deletion include/emp/math/distances.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ namespace emp {
return sqrt(dist);
}

#endif
#endif // DOXYGEN_SHOULD_SKIP_THIS

}

Expand Down
2 changes: 1 addition & 1 deletion include/emp/meta/TypePack.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ namespace emp {
using result_t = emp::TypePack<emp::TypePack<>>;
};
}
#endif DOXYGEN_SHOULD_SKIP_THIS
#endif // DOXYGEN_SHOULD_SKIP_THIS

template <typename T, int N>
using TypePackFill = typename internal::tp_pad<TypePack<>,T,N>::type;
Expand Down
2 changes: 1 addition & 1 deletion include/emp/meta/ValPack.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ namespace emp {
};
template <> struct vp_sort<ValPack<>> { using result = ValPack<>; };
} // End internal namespace
#endif DOXYGEN_SHOULD_SKIP_THIS
#endif // DOXYGEN_SHOULD_SKIP_THIS

/// Generate a ValPack with a specified range of values.
template <auto START, auto END, auto STEP=1>
Expand Down
6 changes: 3 additions & 3 deletions include/emp/meta/meta.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ namespace emp {

template <size_t ID, typename... Ts>
using pack_id = typename internal::pack_id_impl<ID,Ts...>::type;
#endif DOXYGEN_SHOULD_SKIP_THIS
#endif // DOXYGEN_SHOULD_SKIP_THIS

// Trim off the last type from a pack.
template <typename... Ts> using last_type = pack_id<sizeof...(Ts)-1,Ts...>;
Expand Down Expand Up @@ -131,7 +131,7 @@ namespace emp {
template <template <typename...> class FILTER, typename T>
constexpr bool tt_exist_impl(...) { return false; }
}
#endif DOXYGEN_SHOULD_SKIP_THIS
#endif // DOXYGEN_SHOULD_SKIP_THIS

template <template <typename...> class TEST, typename T>
constexpr bool test_type_exist() { return internal::tt_exist_impl<TEST, T>(true); }
Expand Down Expand Up @@ -252,7 +252,7 @@ namespace emp {
using type = T<U...>;
};
}
#endif DOXYGEN_SHOULD_SKIP_THIS
#endif // DOXYGEN_SHOULD_SKIP_THIS

template<typename T, typename... U>
using AdaptTemplate = typename internal::AdaptTemplateHelper<T, U...>::type;
Expand Down
2 changes: 1 addition & 1 deletion include/emp/web/RawImage.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ namespace emp {
};

} // End internal namespace
#endif DOXYGEN_SHOULD_SKIP_THIS
#endif // DOXYGEN_SHOULD_SKIP_THIS

/// Fundamental information about a single image.
class RawImage {
Expand Down
2 changes: 1 addition & 1 deletion include/emp/web/d3/visualizations.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -807,7 +807,7 @@ class TreeVisualization : public D3Visualization {
std::function<std::string(NODE, int)> color_fun_link = [](NODE d, int i){
return "black";
};
#endif DOXYGEN_SHOULD_SKIP_THIS
#endif // DOXYGEN_SHOULD_SKIP_THIS

public:
D3::TreeLayout<NODE> tree;
Expand Down

0 comments on commit 99532c0

Please sign in to comment.