Skip to content

Commit

Permalink
Use /// for docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
IvanUkhov committed May 21, 2024
1 parent d8b6307 commit 35d0494
Show file tree
Hide file tree
Showing 10 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions src/compact1/character_set.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ pub struct CharacterSet2 {
}

table! {
#[doc = "A range of a character set in format 1."]
/// A range of a character set in format 1.
#[derive(Copy)]
pub Range1 {
first_string_id (StringID), // first
Expand All @@ -45,7 +45,7 @@ table! {
}

table! {
#[doc = "A range of a character set in format 2."]
/// A range of a character set in format 2.
#[derive(Copy)]
pub Range2 {
first_string_id (StringID), // first
Expand Down
10 changes: 5 additions & 5 deletions src/compact1/encoding.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ pub enum Encoding {
}

table! {
#[doc = "An encoding in format 0."]
/// An encoding in format 0.
pub Encoding0 { // Format 0
format (u8) = { 0 }, // format
code_count (u8), // nCodes
Expand All @@ -26,7 +26,7 @@ table! {
}

table! {
#[doc = "An encoding in format 1."]
/// An encoding in format 1.
pub Encoding1 { // Format 1
format (u8) = { 1 }, // format
range_count (u8), // nRanges
Expand All @@ -38,7 +38,7 @@ table! {
}

table! {
#[doc = "An encoding in the supplemental format."]
/// An encoding in the supplemental format.
pub EncodingSupplemental { // Supplemental Encoding Data
format (u8),
supplement_count (u8), // nSups
Expand All @@ -50,7 +50,7 @@ table! {
}

table! {
#[doc = "A range of an encoding in format 1."]
/// A range of an encoding in format 1.
#[derive(Copy)]
pub Range1 {
first_code (u8), // first
Expand All @@ -59,7 +59,7 @@ table! {
}

table! {
#[doc = "A supplement of an encoding in the supplemental format."]
/// A supplement of an encoding in the supplemental format.
#[derive(Copy)]
pub Supplement {
code (u8 ), // code
Expand Down
4 changes: 2 additions & 2 deletions src/compact1/font_set/character_id_keyed.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ pub struct Encoding0 {
}

table! {
#[doc = "A glyph-to-dictionary encoding in format 3."]
/// A glyph-to-dictionary encoding in format 3.
pub Encoding3 {
format (u8 ) = { 3 }, // format
range_count (u16), // nRanges
Expand All @@ -55,7 +55,7 @@ table! {
}

table! {
#[doc = "A range of a glyph-to-dictionary encoding in format 3."]
/// A range of a glyph-to-dictionary encoding in format 3.
#[derive(Copy)]
pub Range3 {
first_glyph_id (GlyphID), // first
Expand Down
2 changes: 1 addition & 1 deletion src/compact1/header.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use crate::compact1::OffsetSize;

table! {
#[doc = "A header."]
/// A header.
#[derive(Copy)]
pub Header {
major (u8 ), // major
Expand Down
2 changes: 1 addition & 1 deletion src/compact1/index/character_strings.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ use crate::Result;

index! {
@define
#[doc = "A character-string index."]
/// A character-string index.
pub CharacterStrings
}

Expand Down
2 changes: 1 addition & 1 deletion src/compact1/index/dictionaries.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use crate::tape::Read;
use crate::{Error, Result};

index! {
#[doc = "A dictionary index."]
/// A dictionary index.
pub Dictionaries
}

Expand Down
2 changes: 1 addition & 1 deletion src/compact1/index/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use crate::Result;

table! {
@define
#[doc = "An index."]
/// An index.
pub Index {
count (u16 ), // count
offset_size (OffsetSize ), // offSize
Expand Down
2 changes: 1 addition & 1 deletion src/compact1/index/names.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ use crate::compact1::index::Index;
use crate::{Error, Result};

index! {
#[doc = "A name index."]
/// A name index.
pub Names
}

Expand Down
2 changes: 1 addition & 1 deletion src/compact1/index/strings.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use crate::compact1::StringID;
const NUMBER_OF_STANDARD_STRINGS: usize = 391;

index! {
#[doc = "A string index."]
/// A string index.
pub Strings
}

Expand Down
2 changes: 1 addition & 1 deletion src/compact1/index/subroutines.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
index! {
#[doc = "A subroutine index."]
/// A subroutine index.
#[derive(Default)]
pub Subroutines
}

0 comments on commit 35d0494

Please sign in to comment.