Refactoring #2390

Core: Intensity/ArrayUtils.h: CreateDataImpl: Revise and document

Added by wuttke about 1 year ago. Updated 9 days ago.

Status:BacklogStart date:31 Jul 2019
Priority:LowDue date:
Assignee:-% Done:

0%

Category:-
Target version:-

Description

In Core/Instrument/ArrayUtils.h: Why CreateDataImpl is a class? Wouldn't a namespace be sufficient, and more to the point?

Please explain the purpose of each function.

An extant comment says "Intended for vectors only". Please specify which vector classes are supported (std::vector? BasicVector3D? ...).

Since this machinery is very complicated, exceptionally do not only explain why, but also how things are done.

Exists there a unit test that demonstrates how these functions are to be used? If yes, provide a link. If not, please consider writing a unit test.

History

#1 Updated by wuttke about 1 year ago

  • Subject changed from Refactoring? Documentation for sure to Revise and document CreateDataImpl
  • Description updated (diff)

#2 Updated by wuttke 9 days ago

  • Subject changed from Revise and document CreateDataImpl to Core: Intensity/ArrayUtils.h: CreateDataImpl: Revise and document
  • Status changed from New to Backlog
  • Priority changed from Normal to Low

Also available in: Atom PDF