diff options
| author | Kenneth Lundin <[email protected]> | 2010-01-13 15:08:55 +0000 |
|---|---|---|
| committer | Erlang/OTP <[email protected]> | 2010-01-13 15:08:55 +0000 |
| commit | 68c2f188c3446f53fad03d0f652207a9a8bb1946 (patch) | |
| tree | 08fd761497f4cd74b17515be8e94e309f6cd0ac2 /system/doc/reference_manual/modules.xml | |
| parent | bcf62deb7b8534b00ce69c977466a009252ee8a5 (diff) | |
| download | otp-68c2f188c3446f53fad03d0f652207a9a8bb1946.tar.gz otp-68c2f188c3446f53fad03d0f652207a9a8bb1946.tar.bz2 otp-68c2f188c3446f53fad03d0f652207a9a8bb1946.zip | |
OTP-8366 Type specifications (-type and -spec) are now described in the
reference manual.<br/>Note!, they are still preliminary.
Diffstat (limited to 'system/doc/reference_manual/modules.xml')
| -rw-r--r-- | system/doc/reference_manual/modules.xml | 30 |
1 files changed, 17 insertions, 13 deletions
diff --git a/system/doc/reference_manual/modules.xml b/system/doc/reference_manual/modules.xml index f4885be480..0dbc0ab56b 100644 --- a/system/doc/reference_manual/modules.xml +++ b/system/doc/reference_manual/modules.xml @@ -4,7 +4,7 @@ <chapter> <header> <copyright> - <year>2003</year><year>2009</year> + <year>2003</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + </legalnotice> <title>Modules</title> @@ -170,17 +170,21 @@ fact(0) -> % | <section> <title>Types and function specifications</title> - <p>The current release implements types and function specifications - as described in + <p>A similar syntax as for module attributes is used for + specifying types and function specifications. + </p> + <pre> +-type my_type() :: atom() | integer(). +-spec my_function(integer()) -> integer(). + </pre> + <p>Read more in <seealso marker="typespec">Types and Function specifications</seealso>. + </p> + <p> + The desciption is based on <url href="http://www.erlang.org/eeps/eep-0008.html">EEP8 - -Types and function specifications</url>. - - <note> - <p>The implementation and EEP8 may not exactly correspond to - each other. In a future release, type and function specifications - will be described in this reference manual.</p> - </note> - </p> + Types and function specifications</url> + which will not be further updated. + </p> </section> </section> |