Add more commentsin cros_component_installer

chrome/browser/component_updater/cros_component_installer.h

 // Copyright 2017 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_BROWSER_COMPONENT_UPDATER_CROS_COMPONENT_INSTALLER_H_
 #define CHROME_BROWSER_COMPONENT_UPDATER_CROS_COMPONENT_INSTALLER_H_
 
 #include <string>
 
 #include "build/build_config.h"
@@ skipping 42 matching lines @@
   std::string dir_name;
   std::string name;
   uint8_t kSha2Hash_[crypto::kSHA256Length] = {};
 
   DISALLOW_COPY_AND_ASSIGN(CrOSComponentInstallerTraits);
 };
 
 // This class contains functions used to register and install a component.
 class CrOSComponent {
  public:
-  // Register and start installing a CrOS component.
-  // |install_callback| is triggered after install finishes and returns error
-  // code: update_client::Error::INVALID_ARGUMENT - component name is invalid.
-  // update_client::Error::NONE
-  // - successful install
-  // other error returns are processed by OnDemandUpdate upon install finishes.
+  //  Register and start installing a CrOS component.
+  //  |install_callback| is triggered after install finishes and returns error
+  //  code.
+  //
+  //  example:
+  //  ...
+  //  void PerformOperations(chromeos::DBusMethodCallStatus call_status,
+  //                         const std::string& version){
+  //    if (call_status != chromeos::DBUS_METHOD_CALL_SUCCESS) {
+  //      DVLOG(1) << "Call to imageloader service failed.";
+  //      return;
+  //    }
+  //    if (version.empty()) {
+  //      DVLOG(1) << "[PerformOperations] Component is not installed";
+  //      return;
+  //    }
+  //    // [mounted compnent path: /run/imageloader/[component name]/[version]]
+  //    //
+  //    // [component is ready to do your work]
+  //  }
+  //  void install_callback(update_client::Error error){
+  //    // switch(error){
+  //    //   case update_client::Error::NONE:
+  //    //     // component is installed
+  //    //     break;
+  //    //   case update_client::Error::INVALID_ARGUMENT:
+  //    //     // your install failed due of your wrong parameters.
+  //    //     break;
+  //    //   default:
+  //    //     // your install failed due to system failure.
+  //    //     break;
+  //    // }
+  //    // Even when error code other than NONE returned (your install failed),
+  //    // component might has already being installed previously.
+  //    // Plus, if you want to know current version of component.
+  //    chromeos::ImageLoaderClient* loader =
+  //              chromeos::DBusThreadManager::Get()->GetImageLoaderClient();
+  //    if (loader) {
+  //      loader->GetComponentVersion("escpr", base::Bind(&PerformOperations));
+  //    } else {
+  //      VLOG(0) << "Failed to get ImageLoaderClient object.";
+  //    }
+  //  }
+  //  ...
+  //    component_updater::CrOSComponent::InstallCrOSComponent(
+  //              name,
+  //              base::Bind(&install_callback));
+  //
   static bool InstallCrOSComponent(
       const std::string& name,
       const update_client::Callback& install_callback);
 
  private:
   CrOSComponent() {}
   // Register a component.
   static void RegisterCrOSComponentInternal(ComponentUpdateService* cus,
                                             const ComponentConfig& config,
                                             const base::Closure& callback);
   // A helper function to pass into RegisterCrOSComonentInternal as a callback.
   // It calls OnDemandUpdate to install the component right after being
   // registered.
   static void InstallChromeOSComponent(
       ComponentUpdateService* cus,
       const std::string& id,
       const update_client::Callback& install_callback);
 };
 #endif  // defined(OS_CHROMEOS)
 
 }  // namespace component_updater
 
 #endif  // CHROME_BROWSER_COMPONENT_UPDATER_CROS_COMPONENT_INSTALLER_H_