storage: add links to documentation

service/lib/agama/storage/config.rb

@@ -25,7 +25,10 @@
 
 module Agama
   module Storage
-    # Settings used to calculate an storage proposal.
+    # Config used to calculate an storage proposal.
+    #
+    # See doc/storage_proposal_from_profile.md for a complete description of how the config is
+    # generated from a profile.
     class Config
       include Copyable
 

service/lib/agama/storage/config_conversions/from_json.rb

@@ -27,6 +27,9 @@ module Agama
   module Storage
     module ConfigConversions
       # Config conversion from JSON hash according to schema.
+      #
+      # See doc/storage_proposal_from_profile.md for a complete description of how the config is
+      # generated from a profile.
       class FromJSON
         # @param config_json [Hash]
         # @param default_paths [Array<String>] Default paths of the product.

service/lib/agama/storage/config_json_solver.rb

@@ -57,6 +57,9 @@ module Storage
     #                         }
     #                       ]
     #                     }
+    #
+    # See doc/storage_proposal_from_profile.md for a complete description of how the config is
+    # generated from a profile.
     class ConfigJSONSolver
       # @param default_paths [Array<String>] Default paths of the product.
       # @param mandatory_paths [Array<String>] Mandatory paths of the product.

service/lib/agama/storage/config_solver.rb

@@ -31,6 +31,9 @@ module Storage
     # Solving a config means to assign proper values according to the product and the system. For
     # example, the sizes of a partition config taking into account its fallbacks, assigning a
     # specific device when a config has a search, etc.
+    #
+    # See doc/storage_proposal_from_profile.md for a complete description of how the config is
+    # generated from a profile.
     class ConfigSolver
       # @param devicegraph [Y2Storage::Devicegraph] initial layout of the system
       # @param product_config [Agama::Config] configuration of the product to install

service/lib/agama/storage/configs/size.rb

@@ -36,6 +36,8 @@ def self.new_for_shrink_if_needed
           end
         end
 
+        # Whether the size is the default size for the volume.
+        #
         # @return [Boolean]
         attr_accessor :default
         alias_method :default?, :default