Skip to content
This repository has been archived by the owner on May 2, 2020. It is now read-only.

Commit

Permalink
Update NEWS.md and docs. [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
@MichaelHatherly
MichaelHatherly committed May 20, 2015
1 parent 9e4400c commit d57fd80
Show file tree
Hide file tree
Showing 12 changed files with 377 additions and 317 deletions.
4 changes: 4 additions & 0 deletions NEWS.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
### v0.5.3

* Fix method finding bug for multiline signatures.

### v0.5.2

* Fix escaping bug.
Expand Down
60 changes: 37 additions & 23 deletions docs/api/Docile.Cache.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Remove all cached objects, modules and packages from storage.


*source:*
[Docile/src/Cache/storage.jl:217](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L217)
[Docile/src/Cache/storage.jl:217](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L217)

---

Expand All @@ -21,7 +21,7 @@ Return a reference to the metadata cache for a given module `m`.


*source:*
[Docile/src/Cache/storage.jl:201](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L201)
[Docile/src/Cache/storage.jl:201](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L201)

---

Expand All @@ -31,7 +31,7 @@ Return the metadata `Dict` for a given object `obj` found in module `m`.


*source:*
[Docile/src/Cache/storage.jl:206](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L206)
[Docile/src/Cache/storage.jl:206](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L206)

---

Expand All @@ -41,7 +41,7 @@ Return a reference to the parsed docstring cache for a given module `m`.


*source:*
[Docile/src/Cache/storage.jl:182](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L182)
[Docile/src/Cache/storage.jl:182](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L182)

---

Expand All @@ -54,7 +54,7 @@ user-definable `Docile.Formats.parsedocs` method.


*source:*
[Docile/src/Cache/storage.jl:190](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L190)
[Docile/src/Cache/storage.jl:190](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L190)

---

Expand All @@ -64,7 +64,7 @@ Return a reference to the raw docstring storage for a given module `m`.


*source:*
[Docile/src/Cache/storage.jl:166](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L166)
[Docile/src/Cache/storage.jl:166](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L166)

---

Expand All @@ -74,7 +74,7 @@ Return the raw docstring for a given `obj` in the module `m`.


*source:*
[Docile/src/Cache/storage.jl:171](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L171)
[Docile/src/Cache/storage.jl:171](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L171)

---

Expand All @@ -84,7 +84,7 @@ List of all documented objects in a module `m`.


*source:*
[Docile/src/Cache/storage.jl:222](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L222)
[Docile/src/Cache/storage.jl:222](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L222)


## Methods [Internal]
Expand All @@ -97,7 +97,7 @@ Empty cached docstrings, parsed docs, and metadata from all modules.


*source:*
[Docile/src/Cache/storage.jl:158](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L158)
[Docile/src/Cache/storage.jl:158](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L158)

---

Expand All @@ -107,7 +107,7 @@ Empty all loaded packages and modules from cache.


*source:*
[Docile/src/Cache/storage.jl:103](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L103)
[Docile/src/Cache/storage.jl:103](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L103)

---

Expand All @@ -118,7 +118,21 @@ for the docstring `raw`.


*source:*
[Docile/src/Cache/utilities.jl:50](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/utilities.jl#L50)
[Docile/src/Cache/utilities.jl:50](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/utilities.jl#L50)

---

<a id="method__findmeta.1" class="lexicon_definition"></a>
#### findmeta(m::Module, obj, key::Symbol) [](#method__findmeta.1)
Find the most relevant metadata with key `key`.

Search path begins with the object `obj` itself, then the module's `ModuleData`,
followed by any parent `ModuleData` objects. Once `Main` is reached the
rootmodule's `PackageData` is searched.


*source:*
[Docile/src/Cache/utilities.jl:10](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/utilities.jl#L10)

---

Expand All @@ -128,7 +142,7 @@ Return documentation cache of a module `m`. Initialise an empty cache if needed.


*source:*
[Docile/src/Cache/storage.jl:150](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L150)
[Docile/src/Cache/storage.jl:150](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L150)

---

Expand All @@ -138,7 +152,7 @@ Get the `ModuleData` object associated with a module `m`.


*source:*
[Docile/src/Cache/storage.jl:63](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L63)
[Docile/src/Cache/storage.jl:63](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L63)

---

Expand All @@ -148,7 +162,7 @@ Return the `PackageData` object that represents a registered package.


*source:*
[Docile/src/Cache/storage.jl:83](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L83)
[Docile/src/Cache/storage.jl:83](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L83)

---

Expand All @@ -158,7 +172,7 @@ Has module `m` had documentation extracted with `Docile.Collector.docstrings`?


*source:*
[Docile/src/Cache/storage.jl:145](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L145)
[Docile/src/Cache/storage.jl:145](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L145)

---

Expand All @@ -170,7 +184,7 @@ When module isn't found then check for newly added packages first.


*source:*
[Docile/src/Cache/storage.jl:58](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L58)
[Docile/src/Cache/storage.jl:58](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L58)

---

Expand All @@ -182,7 +196,7 @@ When package isn't found then check for newly added packages first.


*source:*
[Docile/src/Cache/storage.jl:78](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L78)
[Docile/src/Cache/storage.jl:78](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L78)

---

Expand All @@ -192,7 +206,7 @@ Has module `m` been parsed yet?


*source:*
[Docile/src/Cache/storage.jl:112](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L112)
[Docile/src/Cache/storage.jl:112](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L112)

---

Expand All @@ -202,7 +216,7 @@ List of all documented modules currently stored by Docile.


*source:*
[Docile/src/Cache/storage.jl:140](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L140)
[Docile/src/Cache/storage.jl:140](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L140)

---

Expand All @@ -214,7 +228,7 @@ Also extracts additional embedded metadata found in each raw docstring.


*source:*
[Docile/src/Cache/utilities.jl:37](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/utilities.jl#L37)
[Docile/src/Cache/utilities.jl:37](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/utilities.jl#L37)

---

Expand All @@ -224,7 +238,7 @@ Module `m` has had it's docstrings parsed.


*source:*
[Docile/src/Cache/storage.jl:117](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L117)
[Docile/src/Cache/storage.jl:117](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L117)

---

Expand All @@ -236,7 +250,7 @@ Switch on/off documenting of ``Base`` and it's submodules.


*source:*
[Docile/src/Cache/storage.jl:23](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L23)
[Docile/src/Cache/storage.jl:23](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L23)

## Macros [Internal]

Expand All @@ -248,5 +262,5 @@ Macro to make a function definition global. Used in `let`-blocks.


*source:*
[Docile/src/Cache/storage.jl:6](https://github.com/MichaelHatherly/Docile.jl/tree/7701224579bea92e6ad5f70a3c2da426c0a1dce7/src/Cache/storage.jl#L6)
[Docile/src/Cache/storage.jl:6](https://github.com/MichaelHatherly/Docile.jl/tree/9e4400cceb561a35e708b94e33e3992298437d7a/src/Cache/storage.jl#L6)

Loading

0 comments on commit d57fd80

Please sign in to comment.