fixup various docstrings
This commit is contained in:
Dane Springmeyer
parent
982a829ce2
commit
a651bc9940
3 changed files with 34 additions and 34 deletions
|
|
@ -90,7 +90,7 @@ public:
|
|||
std::vector<std::string>& styles();
|
||||
|
||||
/*!
|
||||
* @param max_zoom The minimum zoom level to set
|
||||
* @param min_zoom The minimum zoom level to set
|
||||
*/
|
||||
void set_min_zoom(double min_zoom);
|
||||
|
||||
|
|
@ -136,7 +136,7 @@ public:
|
|||
*
|
||||
* @return true if this layer's data is active and visible at a given scale.
|
||||
* Otherwise returns False.
|
||||
* @return false if:
|
||||
* false if:
|
||||
* scale >= minzoom - 1e-6
|
||||
* or
|
||||
* scale < maxzoom + 1e-6
|
||||
|
|
@ -154,7 +154,7 @@ public:
|
|||
bool clear_label_cache() const;
|
||||
|
||||
/*!
|
||||
* @param clear_cache Set whether this layer's features should be cached if used by multiple styles.
|
||||
* @param cache_features Set whether this layer's features should be cached if used by multiple styles.
|
||||
*/
|
||||
void set_cache_features(bool cache_features);
|
||||
|
||||
|
|
@ -164,7 +164,7 @@ public:
|
|||
bool cache_features() const;
|
||||
|
||||
/*!
|
||||
* @param group_by Set the field rendering of this layer is grouped by.
|
||||
* @param column Set the field rendering of this layer is grouped by.
|
||||
*/
|
||||
void set_group_by(std::string column);
|
||||
|
||||
|
|
|
|||
|
|
@ -152,7 +152,7 @@ public:
|
|||
* @param name The name of the style.
|
||||
* @param style The style to insert.
|
||||
* @return true If success.
|
||||
* @return false If no success.
|
||||
* false If no success.
|
||||
*/
|
||||
bool insert_style(std::string const& name,feature_type_style const& style);
|
||||
|
||||
|
|
@ -169,9 +169,9 @@ public:
|
|||
|
||||
/*! \brief Insert a fontset into the map.
|
||||
* @param name The name of the fontset.
|
||||
* @param style The fontset to insert.
|
||||
* @param fontset The fontset to insert.
|
||||
* @return true If success.
|
||||
* @return false If failure.
|
||||
* false If failure.
|
||||
*/
|
||||
bool insert_fontset(std::string const& name, font_set const& fontset);
|
||||
|
||||
|
|
@ -273,7 +273,7 @@ public:
|
|||
boost::optional<color> const& background() const;
|
||||
|
||||
/*! \brief Set the map background image filename.
|
||||
* @param c Background image filename.
|
||||
* @param image_filename Background image filename.
|
||||
*/
|
||||
void set_background_image(std::string const& image_filename);
|
||||
|
||||
|
|
@ -309,8 +309,8 @@ public:
|
|||
*/
|
||||
std::string const& base_path() const;
|
||||
|
||||
/*! \brief Set the map base path where paths should be releative to.
|
||||
* @param srs Map base_path.
|
||||
/*! \brief Set the map base path where paths should be relative to.
|
||||
* @param base Map base_path.
|
||||
*/
|
||||
void set_base_path(std::string const& base);
|
||||
|
||||
|
|
|
|||
|
|
@ -72,7 +72,7 @@ public:
|
|||
//!
|
||||
//! \param[in] value The stop value
|
||||
//! \param[in] mode The stop mode
|
||||
//! \param[in] color The stop color
|
||||
//! \param[in] _color The stop color
|
||||
colorizer_stop(float value = 0,
|
||||
colorizer_mode mode = COLORIZER_INHERIT,
|
||||
color const& _color = color(0,0,0,0),
|
||||
|
|
@ -87,39 +87,39 @@ public:
|
|||
|
||||
//! \brief Set the stop value
|
||||
//! \param[in] value The stop value
|
||||
inline void set_value(float value) { value_ = value; };
|
||||
inline void set_value(float value) { value_ = value; }
|
||||
|
||||
//! \brief Get the stop value
|
||||
//! \return The stop value
|
||||
inline float get_value() const {return value_; };
|
||||
inline float get_value() const { return value_; }
|
||||
|
||||
|
||||
//! \brief Set the stop mode
|
||||
//! \param[in] mode The stop mode
|
||||
inline void set_mode(colorizer_mode mode) { mode_ = mode; };
|
||||
inline void set_mode_enum(colorizer_mode_enum mode) { set_mode(mode); };
|
||||
inline void set_mode(colorizer_mode mode) { mode_ = mode; }
|
||||
inline void set_mode_enum(colorizer_mode_enum mode) { set_mode(mode); }
|
||||
|
||||
//! \brief Get the stop mode
|
||||
//! \return The stop mode
|
||||
inline colorizer_mode get_mode() const { return mode_; };
|
||||
inline colorizer_mode_enum get_mode_enum() const { return get_mode(); };
|
||||
inline colorizer_mode get_mode() const { return mode_; }
|
||||
inline colorizer_mode_enum get_mode_enum() const { return get_mode(); }
|
||||
|
||||
|
||||
//! \brief set the stop color
|
||||
//! \param[in] the stop color
|
||||
inline void set_color(color const& _color) { color_ = _color; };
|
||||
//! \param[in] _color The stop color
|
||||
inline void set_color(color const& _color) { color_ = _color; }
|
||||
|
||||
//! \brief get the stop color
|
||||
//! \return The stop color
|
||||
inline color const& get_color() const {return color_; };
|
||||
inline color const& get_color() const { return color_; }
|
||||
|
||||
//! \brief set the stop label
|
||||
//! \param[in] the stop label
|
||||
inline void set_label(std::string const& label) { label_ = label; };
|
||||
//! \param[in] label The stop label
|
||||
inline void set_label(std::string const& label) { label_ = label; }
|
||||
|
||||
//! \brief get the stop label
|
||||
//! \return The stop label
|
||||
inline std::string const& get_label() const {return label_; };
|
||||
inline std::string const& get_label() const { return label_; }
|
||||
|
||||
|
||||
//! \brief Equality operator
|
||||
|
|
@ -160,22 +160,22 @@ public:
|
|||
void set_default_mode(colorizer_mode mode)
|
||||
{
|
||||
default_mode_ = (mode == COLORIZER_INHERIT) ? COLORIZER_LINEAR:(colorizer_mode_enum)mode;
|
||||
};
|
||||
}
|
||||
|
||||
void set_default_mode_enum(colorizer_mode_enum mode) { set_default_mode(mode); };
|
||||
void set_default_mode_enum(colorizer_mode_enum mode) { set_default_mode(mode); }
|
||||
|
||||
//! \brief Get the default mode
|
||||
//! \return The default mode
|
||||
colorizer_mode get_default_mode() const {return default_mode_; };
|
||||
colorizer_mode_enum get_default_mode_enum() const {return get_default_mode(); };
|
||||
colorizer_mode get_default_mode() const { return default_mode_; }
|
||||
colorizer_mode_enum get_default_mode_enum() const { return get_default_mode(); }
|
||||
|
||||
//! \brief Set the default color
|
||||
//! \param[in] color The default color
|
||||
void set_default_color(color const& color) { default_color_ = color; };
|
||||
void set_default_color(color const& color) { default_color_ = color; }
|
||||
|
||||
//! \brief Get the default color
|
||||
//! \return The default color
|
||||
color const& get_default_color() const {return default_color_; };
|
||||
color const& get_default_color() const { return default_color_; }
|
||||
|
||||
|
||||
//! \brief Add a stop
|
||||
|
|
@ -186,17 +186,17 @@ public:
|
|||
|
||||
//! \brief Set the list of stops
|
||||
//! \param[in] stops The list of stops
|
||||
void set_stops(colorizer_stops const& stops) { stops_ = stops; };
|
||||
void set_stops(colorizer_stops const& stops) { stops_ = stops; }
|
||||
|
||||
//! \brief Get the list of stops
|
||||
//! \return The list of stops
|
||||
colorizer_stops const& get_stops() const {return stops_; };
|
||||
colorizer_stops const& get_stops() const { return stops_; }
|
||||
|
||||
|
||||
//! \brief Colorize a raster
|
||||
//!
|
||||
//! \param[in, out] raster A raster stored in float32 single channel format, which gets colorized in place.
|
||||
//! \param[in] feature used to find 'NODATA' information if available
|
||||
//! \param[in] f The feature used to find 'NODATA' information if available
|
||||
void colorize(raster_ptr const& raster, Feature const& f) const;
|
||||
|
||||
|
||||
|
|
@ -209,11 +209,11 @@ public:
|
|||
|
||||
//! \brief Set the epsilon value for exact mode
|
||||
//! \param[in] e The epsilon value
|
||||
inline void set_epsilon(const float e) { if(e > 0) epsilon_ = e; };
|
||||
inline void set_epsilon(const float e) { if(e > 0) epsilon_ = e; }
|
||||
|
||||
//! \brief Get the epsilon value for exact mode
|
||||
//! \return The epsilon value
|
||||
inline float get_epsilon() const { return epsilon_; };
|
||||
inline float get_epsilon() const { return epsilon_; }
|
||||
|
||||
private:
|
||||
colorizer_stops stops_; //!< The vector of stops
|
||||
|
|
|
|||
Loading…
Reference in a new issue