[3/3] mesos git commit: Added documentation for `protobuf::isTerminalState`.

[bm...@apache.org]

Added documentation for `protobuf::isTerminalState`.

Review: https://reviews.apache.org/r/65108


Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/e91ce42e
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/e91ce42e
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/e91ce42e

Branch: refs/heads/master
Commit: e91ce42ed56c5ab65220fbba740a8a50c7f835ae
Parents: 9a83e41
Author: Benjamin Mahler <bm...@apache.org>
Authored: Thu Jan 11 17:19:25 2018 -0800
Committer: Benjamin Mahler <bm...@apache.org>
Committed: Mon Jan 22 19:22:17 2018 -0800

----------------------------------------------------------------------
 src/common/protobuf_utils.hpp | 5 +++++
 1 file changed, 5 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/mesos/blob/e91ce42e/src/common/protobuf_utils.hpp
----------------------------------------------------------------------
diff --git a/src/common/protobuf_utils.hpp b/src/common/protobuf_utils.hpp
index fd728b7..0ff7239 100644
--- a/src/common/protobuf_utils.hpp
+++ b/src/common/protobuf_utils.hpp
@@ -67,6 +67,11 @@ bool frameworkHasCapability(
     FrameworkInfo::Capability::Type capability);
 
 
+// Returns whether the task state is terminal. Terminal states
+// mean that the resources are released and the task cannot
+// transition back to a non-terminal state. Note that
+// `TASK_UNREACHABLE` is not a terminal state, but still
+// releases the resources.
 bool isTerminalState(const TaskState& state);