[#BloombergLP-balcl-Option-isDescriptionValid]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balcl.adoc[balcl]::xref:BloombergLP/balcl/Option.adoc[Option]::isDescriptionValid
:relfileprefix: ../../../
:mrdocs:

Return whether the description is valid for this option.

== Synopsis

Declared in `<balcl_option.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
isDescriptionValid(std::ostream& stream) const;
----

== Description

Return `true` if the description is valid for this option, leaving the specified `stream` unaffected; otherwise, write a diagnostic message to `stream` and return `false`.

== Return Value

`true` if the description is valid, and `false` otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *stream*
| diagnostic output stream
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#