diff options
Diffstat (limited to 'src/luarocks/path.lua')
-rw-r--r-- | src/luarocks/path.lua | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/src/luarocks/path.lua b/src/luarocks/path.lua index b3b01704..a9f04ef0 100644 --- a/src/luarocks/path.lua +++ b/src/luarocks/path.lua | |||
@@ -49,7 +49,7 @@ function path.manifest_file(tree) | |||
49 | end | 49 | end |
50 | 50 | ||
51 | --- Get the directory for all versions of a package in a tree. | 51 | --- Get the directory for all versions of a package in a tree. |
52 | -- @param name string: The package name. | 52 | -- @param name string: The package name. |
53 | -- @return string: The resulting path -- does not guarantee that | 53 | -- @return string: The resulting path -- does not guarantee that |
54 | -- @param tree string or nil: If given, specifies the local tree to use. | 54 | -- @param tree string or nil: If given, specifies the local tree to use. |
55 | -- the package (and by extension, the path) exists. | 55 | -- the package (and by extension, the path) exists. |
@@ -59,7 +59,7 @@ function path.versions_dir(name, tree) | |||
59 | end | 59 | end |
60 | 60 | ||
61 | --- Get the local installation directory (prefix) for a package. | 61 | --- Get the local installation directory (prefix) for a package. |
62 | -- @param name string: The package name. | 62 | -- @param name string: The package name. |
63 | -- @param version string: The package version. | 63 | -- @param version string: The package version. |
64 | -- @param tree string or nil: If given, specifies the local tree to use. | 64 | -- @param tree string or nil: If given, specifies the local tree to use. |
65 | -- @return string: The resulting path -- does not guarantee that | 65 | -- @return string: The resulting path -- does not guarantee that |
@@ -71,7 +71,7 @@ function path.install_dir(name, version, tree) | |||
71 | end | 71 | end |
72 | 72 | ||
73 | --- Get the local filename of the rockspec of an installed rock. | 73 | --- Get the local filename of the rockspec of an installed rock. |
74 | -- @param name string: The package name. | 74 | -- @param name string: The package name. |
75 | -- @param version string: The package version. | 75 | -- @param version string: The package version. |
76 | -- @param tree string or nil: If given, specifies the local tree to use. | 76 | -- @param tree string or nil: If given, specifies the local tree to use. |
77 | -- @return string: The resulting path -- does not guarantee that | 77 | -- @return string: The resulting path -- does not guarantee that |
@@ -83,7 +83,7 @@ function path.rockspec_file(name, version, tree) | |||
83 | end | 83 | end |
84 | 84 | ||
85 | --- Get the local filename of the rock_manifest file of an installed rock. | 85 | --- Get the local filename of the rock_manifest file of an installed rock. |
86 | -- @param name string: The package name. | 86 | -- @param name string: The package name. |
87 | -- @param version string: The package version. | 87 | -- @param version string: The package version. |
88 | -- @param tree string or nil: If given, specifies the local tree to use. | 88 | -- @param tree string or nil: If given, specifies the local tree to use. |
89 | -- @return string: The resulting path -- does not guarantee that | 89 | -- @return string: The resulting path -- does not guarantee that |
@@ -107,7 +107,7 @@ function path.rock_namespace_file(name, version, tree) | |||
107 | end | 107 | end |
108 | 108 | ||
109 | --- Get the local installation directory for C libraries of a package. | 109 | --- Get the local installation directory for C libraries of a package. |
110 | -- @param name string: The package name. | 110 | -- @param name string: The package name. |
111 | -- @param version string: The package version. | 111 | -- @param version string: The package version. |
112 | -- @param tree string or nil: If given, specifies the local tree to use. | 112 | -- @param tree string or nil: If given, specifies the local tree to use. |
113 | -- @return string: The resulting path -- does not guarantee that | 113 | -- @return string: The resulting path -- does not guarantee that |
@@ -119,7 +119,7 @@ function path.lib_dir(name, version, tree) | |||
119 | end | 119 | end |
120 | 120 | ||
121 | --- Get the local installation directory for Lua modules of a package. | 121 | --- Get the local installation directory for Lua modules of a package. |
122 | -- @param name string: The package name. | 122 | -- @param name string: The package name. |
123 | -- @param version string: The package version. | 123 | -- @param version string: The package version. |
124 | -- @param tree string or nil: If given, specifies the local tree to use. | 124 | -- @param tree string or nil: If given, specifies the local tree to use. |
125 | -- @return string: The resulting path -- does not guarantee that | 125 | -- @return string: The resulting path -- does not guarantee that |
@@ -131,7 +131,7 @@ function path.lua_dir(name, version, tree) | |||
131 | end | 131 | end |
132 | 132 | ||
133 | --- Get the local installation directory for documentation of a package. | 133 | --- Get the local installation directory for documentation of a package. |
134 | -- @param name string: The package name. | 134 | -- @param name string: The package name. |
135 | -- @param version string: The package version. | 135 | -- @param version string: The package version. |
136 | -- @param tree string or nil: If given, specifies the local tree to use. | 136 | -- @param tree string or nil: If given, specifies the local tree to use. |
137 | -- @return string: The resulting path -- does not guarantee that | 137 | -- @return string: The resulting path -- does not guarantee that |
@@ -143,7 +143,7 @@ function path.doc_dir(name, version, tree) | |||
143 | end | 143 | end |
144 | 144 | ||
145 | --- Get the local installation directory for configuration files of a package. | 145 | --- Get the local installation directory for configuration files of a package. |
146 | -- @param name string: The package name. | 146 | -- @param name string: The package name. |
147 | -- @param version string: The package version. | 147 | -- @param version string: The package version. |
148 | -- @param tree string or nil: If given, specifies the local tree to use. | 148 | -- @param tree string or nil: If given, specifies the local tree to use. |
149 | -- @return string: The resulting path -- does not guarantee that | 149 | -- @return string: The resulting path -- does not guarantee that |
@@ -156,7 +156,7 @@ end | |||
156 | 156 | ||
157 | --- Get the local installation directory for command-line scripts | 157 | --- Get the local installation directory for command-line scripts |
158 | -- of a package. | 158 | -- of a package. |
159 | -- @param name string: The package name. | 159 | -- @param name string: The package name. |
160 | -- @param version string: The package version. | 160 | -- @param version string: The package version. |
161 | -- @param tree string or nil: If given, specifies the local tree to use. | 161 | -- @param tree string or nil: If given, specifies the local tree to use. |
162 | -- @return string: The resulting path -- does not guarantee that | 162 | -- @return string: The resulting path -- does not guarantee that |