浏览代码

Add small doc improvements in blob.rs, dense.rs

Johannes Hofmann 8 年前
父节点
当前提交
506293ac1e
共有 2 个文件被更改,包括 11 次插入1 次删除
  1. 10
    0
      src/blob.rs
  2. 1
    1
      src/dense.rs

+ 10
- 0
src/blob.rs 查看文件

18
 use inflate::DeflateDecoder;
18
 use inflate::DeflateDecoder;
19
 
19
 
20
 
20
 
21
+/// The content type of a blob.
21
 #[derive(Debug, Eq, PartialEq)]
22
 #[derive(Debug, Eq, PartialEq)]
22
 pub enum BlobType<'a> {
23
 pub enum BlobType<'a> {
24
+    /// Blob contains a `HeaderBlock`.
23
     OsmHeader,
25
     OsmHeader,
26
+    /// Blob contains a `PrimitiveBlock`.
24
     OsmData,
27
     OsmData,
28
+    /// An unknown blob type with the given string identifier.
29
+    /// Parsers should ignore unknown blobs they do not expect.
25
     Unknown(&'a str),
30
     Unknown(&'a str),
26
 }
31
 }
27
 
32
 
28
 //TODO rename variants to fit proto files
33
 //TODO rename variants to fit proto files
34
+/// The decoded content of a blob (analogous to `BlobType`).
29
 pub enum BlobDecode<'a> {
35
 pub enum BlobDecode<'a> {
36
+    /// Blob contains a `HeaderBlock`.
30
     OsmHeader(HeaderBlock),
37
     OsmHeader(HeaderBlock),
38
+    /// Blob contains a `PrimitiveBlock`.
31
     OsmData(PrimitiveBlock),
39
     OsmData(PrimitiveBlock),
40
+    /// An unknown blob type with the given string identifier.
41
+    /// Parsers should ignore unknown blobs they do not expect.
32
     Unknown(&'a str),
42
     Unknown(&'a str),
33
 }
43
 }
34
 
44
 

+ 1
- 1
src/dense.rs 查看文件

7
 
7
 
8
 
8
 
9
 //TODO Add getter functions for id, version, uid, ...
9
 //TODO Add getter functions for id, version, uid, ...
10
-/// An OpenStreetMap node element from a compressed array of DenseNodes (See [OSM wiki](http://wiki.openstreetmap.org/wiki/Node)).
10
+/// An OpenStreetMap node element from a compressed array of dense nodes (See [OSM wiki](http://wiki.openstreetmap.org/wiki/Node)).
11
 pub struct DenseNode<'a> {
11
 pub struct DenseNode<'a> {
12
     block: &'a osmformat::PrimitiveBlock,
12
     block: &'a osmformat::PrimitiveBlock,
13
 
13