[Insight-developers] Improving module CMake help text

[David Cole]

On Mon, Dec 5, 2011 at 10:44 AM, David Doria <daviddoria at gmail.com> wrote:
>> The itk-module.cmake files already have a DESCRIPTION field:
>>
>>  http://itk.org/gitweb?p=ITK.git;a=blob;f=Modules/Core/Common/itk-module.cmake;hb=v4.0rc03
>>
>> Try the patch below (untested).
>>
>> -Brad
>
> Thanks, that is a good start. However, I'd bet many people will not
> know to press 'h' and will rely on the few words that are presented
> "inline" in ccmake. That is why I am suggesting an additional "short
> string" to very succinctly try to describe what the module contains.
>
> Also, I think there should be a similar short string+description of
> the Groups as well.
>
> David
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Kitware offers ITK Training Courses, for more information visit:
> http://kitware.com/products/protraining.html
>
> Please keep messages on-topic and check the ITK FAQ at:
> http://www.itk.org/Wiki/ITK_FAQ
>
> Follow this link to subscribe/unsubscribe:
> http://www.itk.org/mailman/listinfo/insight-developers

Maybe it should be like a good git commit message, wherein the first
78 characters (or the first line) of DOCUMENTATION is a good "short
version" that can be used where a one-liner is required...

We could easily extract the first N characters, or text up to the
first "\n" for such presentation.