Commit ad19c6d3 authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Improve --import option docs. 

Fixes #515
parent c01c337c

lib/jsduck/options/parser.rb

+11 −4
Original line number Diff line number Diff line
@@ -353,12 +353,19 @@ module JsDuck 


        attribute :import, []

        option('--import=VERSION:PATH',

          "Imports docs generating @since & @new.",

          "Imports exported docs generating @since & @new.",

          "",

          "For example:",

          "First one should generate JSDuck export of some",

          "older versions of his software:",

          "",

          "    $ jsduck app/1.0/src --export=full -o exports/1.0",

          "    $ jsduck app/2.0/src --export=full -o exports/2.0",

          "",

          "And then this exported data can be supplied for",

          "--import to generate versioning data:",

          "",

          "    --import='1.0:/path/to/first/version'",

          "    --import='2.0:/path/to/second/version'",

          "    --import='1.0:exports/1.0'",

          "    --import='2.0:exports/2.0'",

          "    --import='3.0'",

          "",

          "Several versions can be imported using the option multiple",