more doc additions/corrections

epezent · Oct 2, 2023 · 27cff50 · 27cff50
1 parent 56f7169
commit 27cff50
Showing 1 changed file with 12 additions and 13 deletions.
diff --git a/implot.h b/implot.h
@@ -129,17 +129,17 @@ enum ImAxis_ {
     ImAxis_COUNT
 };
 
-// Plotting properties. These provide syntactic sugar for creating ImPlotSpecs from ImProp,value pairs.
+// Plotting properties. These provide syntactic sugar for creating ImPlotSpecs from ImProp,value pairs. See ImPlotSpec documentation.
 enum ImProp_ {
-    ImProp_LineColor,
-    ImProp_LineWeight,
-    ImProp_FillColor,
-    ImProp_FillAlpha,
-    ImProp_Marker,
-    ImProp_Size,
-    ImProp_Offset,
-    ImProp_Stride,
-    ImProp_Flags
+    ImProp_LineColor,  // line color (applies to lines, bar edges, marker edges); IMPLOT_AUTO_COL will use next Colormap color or current item color
+    ImProp_LineWeight, // line weight in pixels (applies to lines, bar edges, marker edges)
+    ImProp_FillColor,  // fill color (applies to shaded regions, bar faces, marker faces); IMPLOT_AUTO_COL will use next Colormap color or current item color
+    ImProp_FillAlpha,  // alpha multiplier (applies to FillColor)
+    ImProp_Marker,     // marker type; specify ImPlotMarker_Auto to use the next unused marker
+    ImProp_Size,       // size of markers (radius), error bar whiskers (width or height), and digital bars (height) *in pixels*
+    ImProp_Offset,     // data index offset
+    ImProp_Stride,     // data stride in bytes; IMPLOT_AUTO will result in sizeof(T) where T is the type passed to PlotX
+    ImProp_Flags       // optional item flags; can be composed from common ImPlotItemFlags and/or specialized ImPlotXFlags
 };
 
 // Options for plots (see BeginPlot).
@@ -487,14 +487,13 @@ enum ImPlotBin_ {
 struct ImPlotSpec {
     ImVec4          LineColor  = IMPLOT_AUTO_COL;       // line color (applies to lines, bar edges, marker edges); IMPLOT_AUTO_COL will use next Colormap color or current item color
     float           LineWeight = 1.0f;                  // line weight in pixels (applies to lines, bar edges, marker edges)
-    ImVec4          FillColor  = IMPLOT_AUTO_COL;       // fill color (applies to bar faces and shaded regions); IMPLOT_AUTO_COL will use next Colormap color or current item color
+    ImVec4          FillColor  = IMPLOT_AUTO_COL;       // fill color (applies to shaded regions, bar faces, marker faces); IMPLOT_AUTO_COL will use next Colormap color or current item color
     float           FillAlpha  = 1.0f;                  // alpha multiplier (applies to FillColor)
     ImPlotMarker    Marker     = ImPlotMarker_None;     // marker type; specify ImPlotMarker_Auto to use the next unused marker
     float           Size       = 4;                     // size of markers (radius), error bar whiskers (width or height), and digital bars (height) *in pixels*
     int             Offset     = 0;                     // data index offset
     int             Stride     = IMPLOT_AUTO;           // data stride in bytes; IMPLOT_AUTO will result in sizeof(T) where T is the type passed to PlotX
-    ImPlotItemFlags Flags      = ImPlotItemFlags_None;  // optional item flags; can be composed from common ImPlotItemFlags and/or specific ImPlotXFlags where X corresponds
-                                                        // with the PlotX function to which this is passed (e.g. ImPlotLineFlags is only compatible with PlotLine)
+    ImPlotItemFlags Flags      = ImPlotItemFlags_None;  // optional item flags; can be composed from common ImPlotItemFlags and/or specialized ImPlotXFlags
 
     ImPlotSpec() { }