Skip to content

Commit

Permalink
Cleanup documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
osubboo committed Sep 24, 2024
1 parent 916bc35 commit dfa298a
Show file tree
Hide file tree
Showing 21 changed files with 750 additions and 794 deletions.
29 changes: 13 additions & 16 deletions groups/bdl/bdlmt/bdlmt_eventscheduler.h
Original file line number Diff line number Diff line change
Expand Up @@ -280,27 +280,26 @@ BSLS_IDENT("$Id: $")
// bdlmt::EventScheduler d_scheduler; // timeout event scheduler
// bsls::TimeInterval d_ioTimeout; // time out
//
// /// Add the specified `connection` to this server and schedule
// /// the timeout event that closes this connection if the data
// /// for this connection does not arrive before the timeout.
// /// Add the specified `connection` to this server and schedule
// /// the timeout event that closes this connection if the data
// /// for this connection does not arrive before the timeout.
// void newConnection(Connection *connection);
//
// /// Close the specified `connection` and remove it from this server.
// /// Close the specified `connection` and remove it from this server.
// void closeConnection(Connection *connection);
//
// /// Return if the specified `connection` has already timed-out.
// /// If not, cancel the existing timeout event for the `connection`,
// /// process the specified `data` of the specified `length` and
// /// schedule a new timeout event that closes the `connection` if
// /// the data does not arrive before the timeout.
// /// Return if the specified `connection` has already timed-out.
// /// If not, cancel the existing timeout event for the `connection`,
// /// process the specified `data` of the specified `length` and
// /// schedule a new timeout event that closes the `connection` if
// /// the data does not arrive before the timeout.
// void dataAvailable(Connection *connection, void *data, int length);
//
// public:
//
// /// Create a `my_Server` object with a timeout value of
// /// `ioTimeout` seconds. Optionally specify a `allocator` used to
// /// supply memory. If `allocator` is 0, the currently installed
// /// default allocator is used.
// /// Create a `my_Server` object with a timeout value of `ioTimeout`
// /// seconds. Optionally specify a `allocator` used to supply memory. If
// /// `allocator` is 0, the currently installed default allocator is used.
// my_Server(const bsls::TimeInterval& ioTimeout,
// bslma::Allocator *allocator = 0);
//
Expand Down Expand Up @@ -371,12 +370,11 @@ BSLS_IDENT("$Id: $")
// object can be created atop the scheduler. A test can then use the test
// time-source to advance the scheduler's observed system-time in order to
// dispatch events in a manner coordinated by the test. Note that a
// `bdlmt::EventSchedulerTestTimeSource` *must* be created on an
// `bdlmt::EventSchedulerTestTimeSource` **must** be created on an
// event-scheduler before any events are scheduled, or the event-scheduler is
// started.
//
// This example shows how the clock may be altered:
//
// ```
// void myCallbackFunction() {
// puts("Event triggered!");
Expand Down Expand Up @@ -415,7 +413,6 @@ BSLS_IDENT("$Id: $")
// scheduler.stop();
// }
// ```
//
// Note that this feature should be used only for testing purposes, never in
// production code.

Expand Down
6 changes: 1 addition & 5 deletions groups/bdl/bdlmt/bdlmt_fixedthreadpool.h
Original file line number Diff line number Diff line change
Expand Up @@ -382,10 +382,6 @@ class FixedThreadPool {
, BCEP_RUN = e_RUN
, BCEP_SUSPEND = e_SUSPEND
, BCEP_DRAIN = e_DRAIN
, TP_STOP = e_STOP
, TP_RUN = e_RUN
, TP_SUSPEND = e_SUSPEND
, TP_DRAIN = e_DRAIN
#endif // BDE_OMIT_INTERNAL_DEPRECATED
};

Expand All @@ -404,7 +400,7 @@ class FixedThreadPool {
bsls::AtomicBool d_drainFlag; // set when draining

bslmt::Barrier d_barrier; // barrier to sync threads
// during 'start' and 'drain'
// during `start` and `drain`

bslmt::Mutex d_metaMutex; // mutex to ensure that there
// is only one controlling
Expand Down
23 changes: 11 additions & 12 deletions groups/bdl/bdlmt/bdlmt_multiqueuethreadpool.h
Original file line number Diff line number Diff line change
Expand Up @@ -116,33 +116,32 @@ BSLS_IDENT("$Id: $")
// public:
// // CREATORS
//
// /// Create a `my_SearchProfile` with the specified `word`.
// /// Optionally specify a `basicAllocator` used to supply memory. If
// /// `basicAllocator` is 0, the default memory allocator is used.
// /// Create a `my_SearchProfile` with the specified `word`.
// /// Optionally specify a `basicAllocator` used to supply memory. If
// /// `basicAllocator` is 0, the default memory allocator is used.
// my_SearchProfile(const char *word,
// bslma::Allocator *basicAllocator = 0);
//
// /// Destroy this search profile.
// /// Destroy this search profile.
// ~my_SearchProfile();
//
// // MANIPULATORS
//
// /// Insert the specified `file` into the file set maintained by this
// /// search profile.
// /// Insert the specified `file` into the file set maintained by this
// /// search profile.
// void insert(const char *file);
//
// // ACCESSORS
//
// /// Return `true` if the specified `file` matches this search
// /// profile.
// /// Return `true` if the specified `file` matches this search profile.
// bool isMatch(const char *file) const;
//
// /// Return a reference to the non-modifiable file set maintained by
// /// this search profile.
// /// Return a reference to the non-modifiable file set maintained by
// /// this search profile.
// const bsl::set<bsl::string>& fileSet() const;
//
// /// Return a reference to the non-modifiable word maintained by this
// /// search profile.
// /// Return a reference to the non-modifiable word maintained by this
// /// search profile.
// const bsl::string& word() const;
// };
// ```
Expand Down
7 changes: 3 additions & 4 deletions groups/bdl/bdlmt/bdlmt_threadmultiplexor.h
Original file line number Diff line number Diff line change
Expand Up @@ -104,14 +104,13 @@ BSLS_IDENT("$Id: $")
// bdlmt::FixedThreadPool *threadPool,
// bslma::Allocator *basicAllocator = 0);
//
// /// Destroy this object.
// /// Destroy this object.
// ~JobQueue();
//
// // MANIPULATORS
//
// /// Process the specified `job` in the thread pool specified at
// /// construction. Return 0 on success, and a non-zero value
// /// otherwise.
// /// Process the specified `job` in the thread pool specified at
// /// construction. Return 0 on success, and a non-zero value otherwise.
// int processJob(const Job& job);
// };
// ```
Expand Down
2 changes: 1 addition & 1 deletion groups/bdl/bdlmt/bdlmt_threadpool.h
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ BSLS_IDENT("$Id: $")

#include <bsls_atomic.h>
#include <bsls_compilerfeatures.h>
#include <bsls_platform.h> // BSLS_PLATFORM_OS_UNIX
#include <bsls_platform.h>
#include <bsls_timeinterval.h>

#include <bsl_deque.h>
Expand Down
Loading

0 comments on commit dfa298a

Please sign in to comment.