doc: 2020-04-01 17:06:52 +0200: 242de73 - Adding documentation
This commit is contained in:
@@ -35,9 +35,65 @@
|
||||
<span id="35">35</span>
|
||||
<span id="36">36</span>
|
||||
<span id="37">37</span>
|
||||
<span id="38">38</span>
|
||||
<span id="39">39</span>
|
||||
<span id="40">40</span>
|
||||
<span id="41">41</span>
|
||||
<span id="42">42</span>
|
||||
<span id="43">43</span>
|
||||
<span id="44">44</span>
|
||||
<span id="45">45</span>
|
||||
<span id="46">46</span>
|
||||
<span id="47">47</span>
|
||||
<span id="48">48</span>
|
||||
<span id="49">49</span>
|
||||
<span id="50">50</span>
|
||||
<span id="51">51</span>
|
||||
<span id="52">52</span>
|
||||
<span id="53">53</span>
|
||||
<span id="54">54</span>
|
||||
<span id="55">55</span>
|
||||
<span id="56">56</span>
|
||||
<span id="57">57</span>
|
||||
<span id="58">58</span>
|
||||
<span id="59">59</span>
|
||||
<span id="60">60</span>
|
||||
<span id="61">61</span>
|
||||
<span id="62">62</span>
|
||||
<span id="63">63</span>
|
||||
<span id="64">64</span>
|
||||
<span id="65">65</span>
|
||||
</pre><div class="example-wrap"><pre class="rust ">
|
||||
<span class="attribute">#![<span class="ident">forbid</span>(<span class="ident">unsafe_code</span>)]</span>
|
||||
|
||||
<span class="doccomment">//! # Mercator Parser</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! Query parser for Mercator.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! ## Mercator: Spatial Index</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! **Mercator** is a spatial *volumetric* index for the</span>
|
||||
<span class="doccomment">//! [Human Brain Project]. It is a component of the [Knowledge Graph]</span>
|
||||
<span class="doccomment">//! service, which provides the spatial anchoring for the metadata</span>
|
||||
<span class="doccomment">//! registered as well as processes the volumetric queries.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! It is build on top of the Iron Sea database toolkit.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! ## Iron Sea: Database Toolkit</span>
|
||||
<span class="doccomment">//! **Iron Sea** provides a set of database engine bricks, which can be</span>
|
||||
<span class="doccomment">//! combined and applied on arbitrary data structures.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! Unlike a traditional database, it does not assume a specific</span>
|
||||
<span class="doccomment">//! physical structure for the tables nor the records, but relies on the</span>
|
||||
<span class="doccomment">//! developer to provide a set of extractor functions which are used by</span>
|
||||
<span class="doccomment">//! the specific indices provided.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! This enables the index implementations to be agnostic from the</span>
|
||||
<span class="doccomment">//! underlying data structure, and re-used.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! [Human Brain Project]: http://www.humanbrainproject.eu</span>
|
||||
<span class="doccomment">//! [Knowledge Graph]: http://www.humanbrainproject.eu/en/explore-the-brain/search/</span>
|
||||
|
||||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">lalrpop_util</span>;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user