Merge pull request #77 from beman-project/add-brief-documentation

adding more basic documentation

Author: dietmarkuehl

Makefile

@@ -100,8 +100,12 @@ clang-format:
 todo:
 	bin/mk-todo.py
 
-clean:
-	$(RM) -r $(BUILD)
+.PHONY: clean-doc
+clean-doc:
+	$(RM) -r docs/html docs/latex
+
+clean: clean-doc
+	$(RM) -r $(BUILD) 
 	$(RM) mkerr olderr *~
 
 distclean: clean

assets/css/style.scss

@@ -18,6 +18,7 @@ namespace beman::execution26::detail {
  * \brief Auxiliary concept used to break cycle for scheduler concept.
  * \headerfile beman/execution26/execution.hpp <beman/execution26/execution.hpp>
  * \internal
+ * \concept almost_scheduler
  */
 template <typename Scheduler>
 concept almost_scheduler = ::std::derived_from<typename ::std::remove_cvref_t<Scheduler>::scheduler_concept,

docs/html/.nojekyll

@@ -11,6 +11,10 @@
 // ----------------------------------------------------------------------------
 
 namespace beman::execution26 {
+/*!
+ * \brief Function used to transform a sender and its arguments for a domain.
+ * \headerfile beman/execution26/execution.hpp <beman/execution26/execution.hpp>
+ */
 template <typename Domain, typename Tag, ::beman::execution26::sender Sender, typename... Args>
     requires requires(Domain domain, Tag tag, Sender&& sender, Args&&... args) {
         domain.apply_sender(Tag(), ::std::forward<Sender>(sender), ::std::forward<Args>(args)...);
@@ -20,6 +24,10 @@ constexpr auto apply_sender(Domain domain, Tag, Sender&& sender, Args&&... args)
     return domain.apply_sender(Tag(), ::std::forward<Sender>(sender), ::std::forward<Args>(args)...);
 }
 
+/*!
+ * \brief Default function used to transform a second and its arguments.
+ * \headerfile beman/execution26/execution.hpp <beman/execution26/execution.hpp>
+ */
 template <typename Domain, typename Tag, ::beman::execution26::sender Sender, typename... Args>
     requires(not requires(Domain domain, Tag tag, Sender&& sender, Args&&... args) {
                 domain.apply_sender(Tag(), ::std::forward<Sender>(sender), ::std::forward<Args>(args)...);

include/beman/execution26/detail/almost_scheduler.hpp

@@ -12,6 +12,7 @@ namespace beman::execution26::detail {
 /*!
  * \brief Concept used to detect callable objects.
  * \headerfile beman/execution26/execution.hpp <beman/execution26/execution.hpp>
+ * \concept callable
  * \internal
  */
 template <typename Fun, typename... Args>

include/beman/execution26/detail/apply_sender.hpp

@@ -36,7 +36,15 @@ namespace beman {
  *
  * \headerfile beman/execution26/execution.hpp <beman/execution26/execution.hpp>
  */
-namespace execution26 {}
+namespace execution26 {
+
+/*!
+ * \namespace beman::execution26::detail
+ * \brief Namespace for implementation details related to beman::execution26
+ * \internal
+ */
+namespace detail {}
+} // namespace execution26
 } // namespace beman
 
 // ----------------------------------------------------------------------------

include/beman/execution26/detail/callable.hpp

@@ -34,6 +34,11 @@ struct completion_domain_merge<completion_domain_undefined, completion_domain_un
     using type = completion_domain_undefined;
 };
 
+/*!
+ * \brief Get a sender's completion domain or the specified default.
+ * \headerfile beman/execution26/execution.hpp <beman/execution26/execution.hpp>
+ * \internal
+ */
 template <typename Default = ::beman::execution26::default_domain, typename Sender>
 constexpr auto completion_domain(const Sender& sender) noexcept {
 

include/beman/execution26/detail/common.hpp

@@ -37,6 +37,7 @@ struct is_set_value<::beman::execution26::set_value_t(Args...)> : ::std::true_ty
  * - set_value_t(A...) for successful completion with a set of argument.
  *
  * \headerfile beman/execution26/execution.hpp <beman/execution26/execution.hpp>
+ * \concept copmletion_signature
  * \internal
  */
 template <typename Fun>

include/beman/execution26/detail/completion_domain.hpp

@@ -11,6 +11,15 @@
 // ----------------------------------------------------------------------------
 
 namespace beman::execution26 {
+/*!
+ * \brief Class template used to a specify a list of completion signatures
+ * \headerfile beman/execution26/execution.hpp <beman/execution26/execution.hpp>
+ *
+ * \details
+ * This class template is primarily used for type computations and objects of
+ * any specializaion are empty. Objects may be created to return them from
+ * functions used for type computations like get_completion_signatures(sender, env).
+ */
 template <::beman::execution26::detail::completion_signature...>
 struct completion_signatures {};
 } // namespace beman::execution26