diff options
| author | Corey Richardson <corey@octayn.net> | 2013-12-06 11:29:58 -0500 |
|---|---|---|
| committer | Corey Richardson <corey@octayn.net> | 2013-12-10 09:43:33 -0500 |
| commit | 94e0a03f5d1d27d34d97c691964c1ff9b5cab086 (patch) | |
| tree | cea008159d1b872a89a720e7abcd36aee6b7b1d0 /doc/tutorial.md | |
| parent | 039a5933fb350dda5263cce824f7da8b86c473df (diff) | |
| download | rust-94e0a03f5d1d27d34d97c691964c1ff9b5cab086.tar.gz rust-94e0a03f5d1d27d34d97c691964c1ff9b5cab086.zip | |
Add rustdoc documentation.
Diffstat (limited to 'doc/tutorial.md')
| -rw-r--r-- | doc/tutorial.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/tutorial.md b/doc/tutorial.md index 624d5528424..f8e81ae8722 100644 --- a/doc/tutorial.md +++ b/doc/tutorial.md @@ -872,9 +872,9 @@ A *destructor* is a function responsible for cleaning up the resources used by an object when it is no longer accessible. Destructors can be defined to handle the release of resources like files, sockets and heap memory. -Objects are never accessible after their destructor has been called, so there -are no dynamic failures from accessing freed resources. When a task fails, the -destructors of all objects in the task are called. +Objects are never accessible after their destructor has been called, so no +dynamic failures are possible from accessing freed resources. When a task +fails, destructors of all objects in the task are called. The `~` sigil represents a unique handle for a memory allocation on the heap: @@ -3254,6 +3254,7 @@ tutorials on individual topics. * [Containers and iterators][container] * [Error-handling and Conditions][conditions] * [Packaging up Rust code][rustpkg] +* [Documenting Rust code][rustdoc] There is further documentation on the [wiki], however those tend to be even more out of date than this document. @@ -3265,6 +3266,7 @@ more out of date than this document. [container]: tutorial-container.html [conditions]: tutorial-conditions.html [rustpkg]: tutorial-rustpkg.html +[rustdoc]: tutorial-rustdoc.html [wiki]: https://github.com/mozilla/rust/wiki/Docs [wiki-packages]: https://github.com/mozilla/rust/wiki/Doc-packages,-editors,-and-other-tools |