Cleanup comments

Author: pmenon

src/include/executor/plan_executor.h

@@ -14,20 +14,23 @@
 
 #include "common/internal_types.h"
 #include "common/statement.h"
-#include "executor/abstract_executor.h"
+#include "executor/logical_tile.h"
 
 namespace peloton {
 
 namespace concurrency {
 class TransactionContext;
-}
+}  // namespace concurrency
 
-namespace executor {
+namespace type {
+class Value;
+}  // namespace type
 
-//===----------------------------------------------------------------------===//
-// Plan Executor
-//===----------------------------------------------------------------------===//
+namespace executor {
 
+/**
+ * The result of the execution of a query/
+ */
 struct ExecutionResult {
   ResultType m_result;
 
@@ -46,14 +49,16 @@ struct ExecutionResult {
 
 class PlanExecutor {
  public:
-  PlanExecutor() = default;
-  DISALLOW_COPY_AND_MOVE(PlanExecutor);
-
-  /*
-   * @brief Use std::vector<type::Value> as params to make it more elegant
-   * for network
-   * Before ExecutePlan, a node first receives value list, so we should
-   * pass value list directly rather than passing Postgres's ParamListInfo
+  /**
+   * This function executes a single query in a transactional context.  The
+   * provided callback is called with the results of the execution with it
+   * completes.
+   *
+   * @param plan The physical query plan that will be run
+   * @param txn The transactional context the query will run in
+   * @param params All parameters the query references
+   * @param result_format No idea ...
+   * @param on_complete The callback function to invoke when the query finishes.
    */
   static void ExecutePlan(
       std::shared_ptr<planner::AbstractPlan> plan,
@@ -63,8 +68,9 @@ class PlanExecutor {
       std::function<void(executor::ExecutionResult,
                          std::vector<ResultValue> &&)> on_complete);
 
-  /*
+  /**
    * @brief When a peloton node recvs a query plan, this function is invoked
+   *
    * @param plan and params
    * @return the number of tuple it executes and logical_tile_list
    */