Skip to content

Commit 2e63b95

Browse files
committed
doc: Expose the enum documentation
1 parent 4a7974a commit 2e63b95

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

src/model/sos.rs

+2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ use crate::{
1212
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
1313
#[cfg_attr(feature = "diff", derive(diff::Diff), diff(attr(#[derive(Debug, Eq, PartialEq, serde::Serialize, serde::Deserialize)])))]
1414
pub enum SOSClass {
15+
/// Special Ordered Sets of type 1 (SOS1 or S1)
1516
S1,
17+
/// Special Ordered Sets of type 2 (SOS2 or S2)
1618
S2,
1719
}
1820

src/model/variable.rs

+7-7
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@ use crate::Rule;
99
pub enum Variable {
1010
/// Unbounded variable (-Infinity, +Infinity)
1111
Free,
12-
// Lower bounded variable
12+
/// Lower bounded variable
1313
LB(f64),
14-
// Upper bounded variable
14+
/// Upper bounded variable
1515
UB(f64),
16-
// Bounded variable
16+
/// Bounded variable
1717
Bounded(f64, f64, bool),
18-
// Integer variable [0, 1]
18+
/// Integer variable [0, 1]
1919
Integer,
20-
// Binary variable
20+
/// Binary variable
2121
Binary,
2222
#[default]
23-
// General variable [0, +Infinity]
23+
/// General variable [0, +Infinity]
2424
General,
25-
// Semi-continuous
25+
/// Semi-continuous
2626
SemiContinuous,
2727
}
2828

0 commit comments

Comments
 (0)