sf_cli 0.0.7.beta2 → 0.0.8

data/lib/sf_cli/sf/data/query.rb

@@ -3,21 +3,17 @@ require_relative './query_helper'
 
 module SfCli::Sf::Data
   module Query
-    # get object records using SOQL.
+    # Get object records using SOQL.
+    # @param soql        [String]        SOQL
+    # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # @param format      [Symbol,String] get the command's raw output. human, csv, json can be available
+    # @param model_class [Class]         the object model class
+    # @param bulk        [Boolean]       use Bulk API
+    # @param timeout     [Integer]       max minutes to wait for the job complete in Bulk API mode
     #
-    # *soql* --- SOQL<br>
+    # @return [Array,[String,Array]] records or a tuple containing a flag and records
     #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # *format* --- get the command's raw output. human, csv, json can be available<br>
-    #
-    # *model_class* --- the object model class<br>
-    #
-    # *bulk* --- use Bulk API<br>
-    #
-    # *timeout* --- max minutes to wait for the job complete in Bulk API mode<br>
-    #
-    # ======
+    # @example
     #   sf.data.query 'SELECT Id, Name FROM Account LIMIT 1' # => [{Id: "abc", Name: "account name"}]
     #
     #   Account = Struct.new(:Id, :Name)
@@ -32,7 +28,7 @@ module SfCli::Sf::Data
     # When using Bulk API, you get the records when the query job completes within time limit.
     # The method returns a tapple(an array), which changes its contents according to the job result.
     #
-    # ======
+    # @example
     #   done, result = sf.data.query 'SELECT Id, Name FROM Account', bulk: true              # max wait 1 min to get result (default)
     #   done, result = sf.data.query 'SELECT Id, Name FROM Account', bulk: true, timeout: 5  # max wait 5 min to get result
     #   done, result = sf.data.query 'SELECT Id, Name FROM Account', bulk: true, timeout: 0  # returns immediately
@@ -40,9 +36,7 @@ module SfCli::Sf::Data
     #   rows = result   if done     # if job is completed, the result is an array of record
     #   job_id = result unless done # if job hasn't completed or it has aborted, the result is the job ID
     #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_query_unified]
-    #
-    # About querying with auto generated object model, see the section {"Object Model support"}[link://files/README_rdoc.html#label-Object+Model+support+-28experimental-2C+since+0.0.4-29] in README.
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_query_unified command reference
     #
     def query(soql, target_org: nil, format: nil, bulk: false, timeout: nil, model_class: nil)
       flags    = {
@@ -62,17 +56,15 @@ module SfCli::Sf::Data
       return_result(result, raw_output, bulk, model_class)
     end
 
-    # resume a bulk query job, which you previously started, and get records
-    #
-    # *job_id* ---  job ID you want to resume<br>
-    #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
+    # Resume a bulk query job, which you previously started, and get records
+    # @param job_id      [String]        job ID you want to resume
+    # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # @param format      [Symbol,String] get the command's raw output. human, csv, json can be available
+    # @param model_class [Class]         the object model class
     #
-    # *format* --- get the command's raw output. human, csv, json can be available<br>
+    # @return [Array,[String,Array]] records or a tuple containing a flag and records
     #
-    # *model_class* --- the object model class<br>
-    #
-    # ======
+    # @example
     #   # start a query job
     #   result1 = sf.data.query 'SELECT Id, Name FROM Account', bulk: true, timeout: 0  # returns immediately
     #
@@ -86,7 +78,8 @@ module SfCli::Sf::Data
     #
     #   result2 # => if done is true, this is an array of record. Otherwise it should be the Job ID.
     #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_query_resume_unified]
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_query_resume_unified command reference
+    #
     def query_resume(job_id:, target_org: nil, format: nil, model_class: nil)
       flags    = {
         :"bulk-query-id" => job_id,

data/lib/sf_cli/sf/data/query_helper.rb

@@ -2,6 +2,7 @@ require_relative './helper_methods'
 
 module SfCli::Sf::Data
   module Query
+    # @private
     class RegularResultAdjuster # :nodoc: all
       include ::SfCli::Sf::Data::HelperMethods
 
@@ -20,6 +21,7 @@ module SfCli::Sf::Data
       end
     end
 
+    # @private
     class BulkResultAdjuster # :nodoc: all
       include ::SfCli::Sf::Data::HelperMethods
 
@@ -42,6 +44,7 @@ module SfCli::Sf::Data
       end
     end
 
+    # @private
     class RawOutputResultAdjuster # :nodoc: all
       attr_reader :result
 

data/lib/sf_cli/sf/data/resume.rb

@@ -49,12 +49,12 @@ module SfCli::Sf::Data
     end
 
     # View the status of a bulk job.
+    # @param job_id     [String]        job ID you want to resume
+    # @param target_org [Symbol,String] an alias of paticular org, or username can be used
     #
-    # *job_id* ---  job ID you want to resume<br>
+    # @return [JobInfo] job information
     #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # ======
+    # @example
     #   # start a delete job
     #   jobinfo = sf.data.delete_bulk sobject: :TestCustomObject__c, file: 'delete.csv' # this returns immediately
     #   jobinfo.id  # => "750J4000003g1OaIAI" it's job ID
@@ -69,9 +69,9 @@ module SfCli::Sf::Data
     # - in_progress?
     # - completed?
     #
-    # To know job status more, take a look at {the bulk API developer guide}[https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/bulk_api_2_job_states.htm]
+    # To know job status more, take a look at {https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/bulk_api_2_job_states.htm the bulk API developer guide}
     #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_resume_unified]
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_resume_unified command reference
     #
     def resume(job_id:, target_org: nil)
       flags = {

data/lib/sf_cli/sf/data/search.rb

@@ -1,16 +1,15 @@
 module SfCli::Sf::Data
   module Search
-    # search objects using SOSL.
+    # Search objects using SOSL.
+    # @param sosl       [String]        SOSL
+    # @param target_org [Symbol,String] an alias of paticular org, or username can be used
+    # @param format     [Symbol,String] get the command's raw output. human, csv, json can be available.
     #
-    # *sosl* --- SOSL<br>
-    #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # *format* --- get the command's raw output. human, csv, json can be available. *NOTE*: if you choose csv, csv files are downloaded in current directory<br>
-    #
-    # ======
-    #  # example (in irb):
+    # @return [Hash] the search result
+    # @note if you choose csv as format, csv files are downloaded in current directory
     #
+    # @example
+    #  (in irb):
     #  > sf.data.search "FIND {TIM OR YOUNG OR OIL} IN Name Fields"
     #  =>
     #  {"Lead"=>["00Q5j00000WgEuDEAV"],
@@ -24,7 +23,7 @@ module SfCli::Sf::Data
     #     "0065j00001XHJLJAA5"],
     #   "User"=>["0055j00000CcL2bAAF", "0055j00000CcL1YAAV"]}
     #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_search_unified]
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_search_unified command reference
     #
     def search(sosl, target_org: nil, format: nil)
       flags = {

data/lib/sf_cli/sf/data/update_record.rb

@@ -1,23 +1,20 @@
 module SfCli::Sf::Data
   module UpdateRecord
 
-    # update a object record.
-    #
-    # *object_type* --- \Object Type (ex. Account)<br>
-    #
-    # *record_id* --- id of the object<br>
-    #
-    # *where* --- field values that is used to identify a record<br>
-    #
-    # *values* --- field values for update<br>
-    #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # ==== examples
+    # Update a object record.
+    # @param object_type [Symbol,String] object type(ex. Account)
+    # @param record_id   [String]        ID of the object
+    # @param where       [Hash]          field values to identify a record
+    # @param values      [Hash]          field values for update
+    # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # 
+    # @return [String] ID of the record updated 
+    # 
+    # @example
     #   sf.data.update_record :Account, record_id: 'xxxxxxx', values: {Name: 'New Account Name'}
     #   sf.data.update_record :Hoge__c, where: {Name: 'Jonny B.Good', Country: 'USA'}, values: {Phone: 'xxxxx', bar: 2000}
     #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_update_record_unified]
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_update_record_unified command reference
     #
     def update_record(object_type, record_id: nil, where: nil, values: nil, target_org: nil)
       where_conditions  = field_value_pairs(where)

data/lib/sf_cli/sf/data/upsert_bulk.rb

@@ -2,19 +2,16 @@ require_relative './bulk_result_v2'
 
 module SfCli::Sf::Data
   module UpsertBulk
-    # update records using Bulk API 2.0
+    # Update records using Bulk API 2.0
+    # @param file        [String]        path of a CSV file to update records
+    # @param sobject     [Symbol,String] object type(ex. Account)
+    # @param external_id [String]        name of the external ID field.Otherwise it must be Id
+    # @param timeout     [Integer]       max minutes to wait for the job complete the task
+    # @param target_org [Symbol,String]  an alias of paticular org, or username can be used
     #
-    # *file* --- a \CSV file for update records<br>
+    # @return [JobInfo, BulkResultV2] the job result, whose type is changed by situation
     #
-    # *sobject* --- \Object Type (ex. Account)<br>
-    #
-    # *external_id* --- Name of the external ID field, or the Id field<br>
-    #
-    # *timeout* --- max minutes to wait for the job complete the task.<br>
-    #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # ======
+    # @example
     #   # start a upsert job
     #   jobinfo = sf.data.upsert_bulk sobject: :TestCustomObject__c, file: 'upsert.csv' # this returns immediately
     #   jobinfo.id  # => "750J4000003g1OaIAI" it's job ID
@@ -25,7 +22,7 @@ module SfCli::Sf::Data
     #   # Or, you can wait for the job completion with one try.
     #   result = sf.data.upsert_bulk sobject: :TestCustomObject__c, file: 'upsert.csv', timeout: 5  # wait within 5 minutes
     #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_upsert_bulk_unified]
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_upsert_bulk_unified command reference
     #
     def upsert_bulk(file:, sobject:, external_id:, timeout: nil, target_org: nil)
       flags = {

data/lib/sf_cli/sf/data/upsert_resume.rb

@@ -2,15 +2,14 @@ require_relative './bulk_result_v2'
 
 module SfCli::Sf::Data
   module UpsertResume
-    # resume a bulk upsert job you previously started with Bulk API 2.0 and return a bulk result object.
+    # Resume a bulk upsert job you previously started with Bulk API 2.0 and return a bulk result object.
+    # @param job_id     [String]        job ID you want to resume
+    # @param timeout    [Integer]       max minutes to wait for the job complete the task
+    # @param target_org [Symbol,String] an alias of paticular org, or username can be used
     #
-    # *job_id* ---  job ID you want to resume<br>
+    # @return [JobInfo, BulkResultV2] the job result, whose type is changed by situation
     #
-    # *timeout* --- max minutes to wait for the job complete the task.<br>
-    #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # ======
+    # @example
     #   # start a upsert job
     #   jobinfo = sf.data.upsert_bulk sobject: :TestCustomObject__c, file: 'upsert.csv' # this returns immediately
     #   jobinfo.id  # => "750J4000003g1OaIAI" it's job ID
@@ -22,9 +21,7 @@ module SfCli::Sf::Data
     #
     #   puts 'yey!' if result.job_info.completed? # the job has completed
     #
-    # To know more about a job result, take a look at SfCli::Sf::Data module
-    #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_upsert_resume_unified]
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_upsert_resume_unified command reference
     #
     def upsert_resume(job_id:, timeout: nil, target_org: nil)
       flags = {

data/lib/sf_cli/sf/main.rb

@@ -3,24 +3,28 @@ require 'json'
 
 module SfCli
   module Sf
-    # ==== description
-    # The entry class of sf command. It is returned by sf method.
+
+    # The entry class of sf command. It is returned by the sf method.
     # With including Singleton module, the instance of this class is guaranteed as singleton.
     #
-    # ==== examples
+    # @example
     #   sf             # returns a instance of SfCli::Sf
     #   sf.org.display # you can follow the similar syntax to the original command by using method chain.
     #
+    # @private :nodoc: just for developers
     class Main
       include Singleton
 
-      OPERATION_CATEGORIES = %w[Org Sobject Data Project]
+      OPERATION_CATEGORIES = %w[Org Sobject Data Project Apex]
 
       OPERATION_CATEGORIES.each do |category|
         require_relative %(#{category.downcase}/core)
         attr_reader category.downcase.to_sym
       end
 
+      # Generate each sub command object such as org, data and sobject
+      # so that it can chain like `sf.org.display`.
+      #
       def initialize
         OPERATION_CATEGORIES.each do |category|
           instance_variable_set(:"@#{category.downcase}", Object.const_get(%|::SfCli::Sf::#{category}::Core|).new)

data/lib/sf_cli/sf/model/base_methods.rb

@@ -1,6 +1,7 @@
 module SfCli
   module Sf
     module Model
+      # @private :nodoc: just for developers
       module BaseMethods
         def self.included(c)
           c.extend ClassMethods

data/lib/sf_cli/sf/model/class_definition.rb

@@ -5,6 +5,7 @@ require_relative './query_methods'
 module SfCli
   module Sf
     module Model
+      # @private :nodoc: just for developers
       class ClassDefinition
         attr_reader :schema
 

data/lib/sf_cli/sf/model/dml_methods.rb

@@ -1,6 +1,7 @@
 module SfCli
   module Sf
     module Model
+      # @private :nodoc: just for developers
       module DmlMethods
         def self.included(c)
           c.extend ClassMethods

data/lib/sf_cli/sf/model/generator.rb

@@ -3,8 +3,9 @@ require_relative './class_definition'
 module SfCli
   module Sf
     module Model
+      # @private :nodoc: just for developers
       class Generator
-        attr_reader :sf_sobject, :connection
+        attr_reader :connection
 
         def initialize(connection)
           @connection = connection

data/lib/sf_cli/sf/model/query_condition.rb

@@ -4,6 +4,7 @@ module SfCli
   module Sf
     module Model
       module QueryMethods
+        # @private :nodoc: just for developers
         class QueryCondition
           attr_reader :connection, :object_name, :all_field_names, :fields, :conditions, :limit_num, :row_order
 
@@ -123,7 +124,7 @@ module SfCli
           end
 
           def take
-            all.first
+            limit(1).all.first
           end
 
           def select_fields

data/lib/sf_cli/sf/model/query_methods.rb

@@ -3,6 +3,7 @@ require_relative './query_condition'
 module SfCli
   module Sf
     module Model
+      # @private :nodoc: just for developers
       module QueryMethods
         def self.included(c)
           c.extend ClassMethods

data/lib/sf_cli/sf/model/sf_command_connection.rb

@@ -5,9 +5,18 @@ require_relative '../org/core'
 module SfCli
   module Sf
     module Model
+      #
+      # Connection object to access Salesforce based on Sf command
+      #
       class SfCommandConnection
-        attr_reader :sf_data, :sf_org, :sf_sobject, :target_org, :instance_url
+        attr_reader :target_org, :instance_url
 
+        # @private :nodoc: just for developers
+        attr_reader :sf_data, :sf_org, :sf_sobject
+
+        # @param target_org   [Symbol,String] an alias of paticular org, or username can be used
+        # @param instance_url [String]        URL of the instance that the org lives on.
+        #
         def initialize(target_org: nil, instance_url: nil)
           @sf_org = ::SfCli::Sf::Org::Core.new
           @sf_data = ::SfCli::Sf::Data::Core.new
@@ -24,10 +33,20 @@ module SfCli
           end
         end
 
+        # Sf command style query interface for Model module
+        #
+        # For query details, see {SfCli::Sf::Data::Query sf data query}
+        #
+        def exec_query(soql, format: nil, bulk: false, timeout: nil, model_class: nil)
+          sf_data.query(soql, target_org: target_org, format: format, bulk: bulk, timeout: timeout, model_class: model_class)
+        end
+
+        # @private :nodoc: just for developers
         def find(object_type, id, klass)
           sf_data.get_record object_type, record_id: id, target_org: target_org, model_class: klass
         end
 
+        # @private :nodoc: just for developers
         def create(object_type, values, klass = nil)
           id = sf_data.create_record object_type, values: values, target_org: target_org
           return id if klass.nil?
@@ -35,22 +54,22 @@ module SfCli
           find(object_type, id, klass)
         end
 
+        # @private :nodoc: just for developers
         def update(object_type, id, values)
           sf_data.update_record object_type, record_id: id, where: nil, values: values, target_org: target_org
         end
 
+        # @private :nodoc: just for developers
         def delete(object_type, id)
           sf_data.delete_record object_type, record_id: id, where: nil, target_org: target_org
         end
 
+        # @private :nodoc: just for developers
         def query(soql, klass)
           sf_data.query soql, target_org: target_org, model_class: klass
         end
 
-        def exec_query(soql, format: nil, bulk: false, timeout: nil, model_class: nil)
-          sf_data.query(soql, target_org: target_org, format: format, bulk: bulk, timeout: timeout, model_class: model_class)
-        end
-
+        # @private :nodoc: just for developers
         def describe(object_type)
           sf_sobject.describe(object_type, target_org: target_org)
         end

data/lib/sf_cli/sf/model.rb

@@ -3,20 +3,22 @@ require_relative 'model/generator'
 module SfCli
   module Sf
     #
-    # ==== description
-    # The module for \Object \Model definition and generation
-    #
-    # see the section {"Object Model support"}[link://files/README_rdoc.html#label-Object+Model+support+-28experimental-2C+since+0.0.4-29] in README.
+    # The module for object model definition and generation
     #
     module Model
+      # The connection object to access Salesforce
       def self.connection
         @@connection
       end
 
+      # set the connection
       def self.set_connection(conn)
         @@connection = conn
       end
 
+      # generate object models
+      # @param object_names [Array] a list of object name
+      #
       def self.generate(object_names)
         generator = Generator.new(connection)
 

data/lib/sf_cli/sf/org/core.rb

@@ -5,13 +5,13 @@ require_relative './list'
 
 module SfCli
   module Sf
+    #
+    # Org Commands
+    #
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm command reference
+    #
     module Org
-      #
-      # ==== description
-      # The class representing *sf* *org*.
-      #
-      # https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm
-      #
+      # @private :nodoc: just for developers
       class Core
         include ::SfCli::Sf::Core::Base
         include Login

data/lib/sf_cli/sf/org/display.rb

@@ -3,13 +3,14 @@ module SfCli::Sf::Org
     ConnectionInfo = Struct.new(:id, :access_token, :alias, :instance_url, :user_name, :api_version, :status)
 
     #
-    # returns the org's connection information. (equivalent to *sf* *org* *display*)
+    # Returns the org's connection information
+    # @param target_org [Symbol,String] an alias of paticular org, or username can be used
     #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # ======
-    #  # example (in irb):
+    # @note this function returns the org information including security sensitive things such as access token, username and so on.
+    # @return [ConnectionInfo] the org's connection information
     #
+    # @example
+    #  (in irb):
     #  > sf.org.display
     #  =>
     #  #<struct SfCli::Sf::Org::Display::ConnectionInfo
@@ -21,7 +22,7 @@ module SfCli::Sf::Org
     #   api_version="61.0",
     #   status="Connected">
     #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_display_unified]
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_display_unified command reference
     #
     def display(target_org: nil)
       flags    = {:"target-org" => target_org}

data/lib/sf_cli/sf/org/list.rb

@@ -29,23 +29,22 @@ module SfCli::Sf::Org
       end
     end
 
-    # \List orgs you’ve created or authenticated to
+    # List orgs you’ve created or authenticated to
     #
-    # ======
-    #   org_config_list = sf.org.list # returns a list of OrgConfig
+    # @note this function returns org information including security sensitive things such as access token, username and so on.
+    # @return [OrgConfig] the org configulation
     #
-    # \OrgConfig object has a org information including security sensitive things such as access token, username and so on.
+    # @example
+    #   org_config_list = sf.org.list        # returns a list of OrgConfig
     #
-    # It also has some methods to identify its org type:
-    # - devhub?
-    # - sandbox?
-    # - scratch?
-    # - default?
-    # - default_devhub?
+    #   org_config.first.accesstoken         # returns the access token
+    #   org_config.first.instance_url        # returns the org's url
     #
-    # and you can check the org connected like this:
-    #   org_config_list = sf.org.list # returns a list of OrgConfig
-    #   org_config.first.conncected?
+    #   org_config.first.conncected?         # check the connection status
+    #   org_config.first.devhub?             # check if the org is devhub or not
+    #   org_config.first.scratch?            # check if the org is scratch or not
+    #   org_config.first.default?            # check if the org is default or not
+    #   org_config.first.default_devhub?     # check if the org is devhub default or not
     #
     # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_list_unified]
     #

data/lib/sf_cli/sf/org/login.rb

@@ -1,18 +1,15 @@
 module SfCli::Sf::Org
   module Login
-    # login to the org by the browser.
+    # Login to the org by the browser.
+    # @param target_org   [Symbol,String] an alias of paticular org, or username can be used
+    # @param instance_url [String]        URL of the instance that the org lives on.
+    # @param browser      [Symbol,String] browser in which to open the org.
     #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # *instance_url* --- URL of the instance that the org lives on.
-    #
-    # *browser* --- browser in which to open the org.
-    #
-    # == examples:
+    # @example
     #   sf.org.login_web
     #   sf.org.login_web target_org: :dev
     #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_login_web_unified]
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_login_web_unified command reference
     #
     def login_web(target_org: nil, instance_url: nil, browser: nil)
       flags = {
@@ -24,30 +21,27 @@ module SfCli::Sf::Org
       exec(action, flags: flags)
     end
 
-    # login to the org by access token.
-    #
-    # NOTE: this method doesn't support user interactive mode, so *SF_ACCESS_TOKEN* environment variable must be set before call this method.
+    # Login to the org by access token.
+    # @note This method doesn't support user interactive mode, so *SF_ACCESS_TOKEN* environment variable must be set before call this method.
     #
-    # *instance_url* --- URL of the instance that the org lives on.
+    # @param target_org   [Symbol,String] an alias of paticular org, or username can be used
+    # @param instance_url [String]        URL of the instance that the org lives on.
     #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # ======
+    # @example
     #  ENV['SF_ACCESS_TOKEN'] = 'xxxxxxxxxx'
     #  sf.org.login_access_token instance_url: https://hoge.bar.baz.salesforce.com
     #
-    # == how to set env variable outside of ruby
-    # In Unix/mac:
-    #   $ SF_ACCESS_TOKEN='xxxxxxxxxx'
-    #   $ ruby app_using_sfcli.rb
-    # or
-    #   $ SF_ACCESS_TOKEN='xxxxxxxxxx' ruby app_using_sfcli.rb
-    #
-    # In Windows:
-    #   $ set SF_ACCESS_TOKEN=xxxxxxxxxx
-    #   $ ruby app_using_sfcli.rb
-    #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_login_access-token_unified]
+    # How to set env variable outside of Ruby::
+    #   In Unix/mac::
+    #     $ SF_ACCESS_TOKEN='xxxxxxxxxx'
+    #     $ ruby app_using_sfcli.rb
+    #   OR
+    #     $ SF_ACCESS_TOKEN='xxxxxxxxxx' ruby app_using_sfcli.rb
+    #   In Windows::
+    #     $ set SF_ACCESS_TOKEN=xxxxxxxxxx
+    #     $ ruby app_using_sfcli.rb
+    #
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_login_access-token_unified command reference
     #
     def login_access_token(instance_url:, target_org: nil)
       flags = {