Fill in more descriptions

This commit is contained in:
Marek Roszko 2023-08-31 22:17:14 -04:00
parent ab92d2891e
commit aa0df6aaa4
11 changed files with 40 additions and 15 deletions

View File

@ -27,7 +27,10 @@ namespace CLI
{
struct FP_EXPORT_COMMAND : public COMMAND
{
FP_EXPORT_COMMAND() : COMMAND( "export" ) {}
FP_EXPORT_COMMAND() : COMMAND( "export" )
{
m_argParser.add_description( UTF8STDSTR( _( "Export utilities (svg)" ) ) );
}
};
}

View File

@ -27,7 +27,11 @@ namespace CLI
{
struct PCB_EXPORT_COMMAND : public COMMAND
{
PCB_EXPORT_COMMAND() : COMMAND( "export" ) {}
PCB_EXPORT_COMMAND() : COMMAND( "export" )
{
m_argParser.add_description(
UTF8STDSTR( _( "Export utilities (gerbers, drill, position files, etc)" ) ) );
}
};
}

View File

@ -47,11 +47,13 @@
#define REGEX_DELIMITER "(?:[\\s]*x)"
#define REGEX_UNIT "([m]{2}|(?:in))"
CLI::PCB_EXPORT_3D_COMMAND::PCB_EXPORT_3D_COMMAND( const std::string& aName,
CLI::PCB_EXPORT_3D_COMMAND::PCB_EXPORT_3D_COMMAND( const std::string& aName,
const std::string& aDescription,
JOB_EXPORT_PCB_3D::FORMAT aFormat ) :
COMMAND( aName ),
m_format( aFormat )
{
m_argParser.add_description( aDescription );
addCommonArgs( true, true, false );
addDefineArg();

View File

@ -28,7 +28,8 @@ namespace CLI
{
struct PCB_EXPORT_3D_COMMAND : public COMMAND
{
PCB_EXPORT_3D_COMMAND( const std::string& aName,
PCB_EXPORT_3D_COMMAND( const std::string& aName,
const std::string& aDescription,
JOB_EXPORT_PCB_3D::FORMAT aFormat = JOB_EXPORT_PCB_3D::FORMAT::UNKNOWN );
protected:

View File

@ -27,7 +27,11 @@ namespace CLI
{
struct SCH_EXPORT_COMMAND : public COMMAND
{
SCH_EXPORT_COMMAND() : COMMAND( "export" ) {}
SCH_EXPORT_COMMAND() : COMMAND( "export" )
{
m_argParser.add_description(
UTF8STDSTR( _( "Export utilities (netlist, pdf, bom, etc)" ) ) );
}
};
}

View File

@ -31,6 +31,7 @@
CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND() : COMMAND( "bom" )
{
m_argParser.add_description( UTF8STDSTR( _( "Generate a Bill of Material (BOM)" ) ) );
addCommonArgs( true, true, false );
// Field output options

View File

@ -31,6 +31,7 @@
CLI::SCH_EXPORT_NETLIST_COMMAND::SCH_EXPORT_NETLIST_COMMAND() : COMMAND( "netlist" )
{
m_argParser.add_description( UTF8STDSTR( _( "Export a Netlist" ) ) );
addCommonArgs( true, true, false );
m_argParser.add_argument( ARG_FORMAT )

View File

@ -41,11 +41,14 @@ const HPGL_PLOT_ORIGIN_AND_UNITS hpgl_origin_ops[4] = {
};
CLI::SCH_EXPORT_PLOT_COMMAND::SCH_EXPORT_PLOT_COMMAND( const std::string& aName,
const std::string& aDescription,
PLOT_FORMAT aPlotFormat,
bool aOutputIsDir ) :
COMMAND( aName ),
m_plotFormat( aPlotFormat )
{
m_argParser.add_description( aDescription );
addCommonArgs( true, true, aOutputIsDir );
addDrawingSheetArg();
addDefineArg();

View File

@ -29,7 +29,9 @@ namespace CLI
class SCH_EXPORT_PLOT_COMMAND : public COMMAND
{
public:
SCH_EXPORT_PLOT_COMMAND( const std::string& aName, PLOT_FORMAT aPlotFormat,
SCH_EXPORT_PLOT_COMMAND( const std::string& aName,
const std::string& aDescription,
PLOT_FORMAT aPlotFormat,
bool aOutputIsDir = true );
PLOT_FORMAT m_plotFormat;

View File

@ -27,7 +27,11 @@ namespace CLI
{
struct SYM_EXPORT_COMMAND : public COMMAND
{
SYM_EXPORT_COMMAND() : COMMAND( "export" ) {}
SYM_EXPORT_COMMAND() : COMMAND( "export" )
{
m_argParser.add_description(
UTF8STDSTR( _( "Export utilities (svg)" ) ) );
}
};
}

View File

@ -130,9 +130,9 @@ static CLI::PCB_COMMAND pcbCmd{};
static CLI::PCB_DRC_COMMAND pcbDrcCmd{};
static CLI::PCB_EXPORT_DRILL_COMMAND exportPcbDrillCmd{};
static CLI::PCB_EXPORT_DXF_COMMAND exportPcbDxfCmd{};
static CLI::PCB_EXPORT_3D_COMMAND exportPcbGlbCmd{ "glb", JOB_EXPORT_PCB_3D::FORMAT::GLB };
static CLI::PCB_EXPORT_3D_COMMAND exportPcbStepCmd{ "step", JOB_EXPORT_PCB_3D::FORMAT::STEP };
static CLI::PCB_EXPORT_3D_COMMAND exportPcbVrmlCmd{ "vrml", JOB_EXPORT_PCB_3D::FORMAT::VRML };
static CLI::PCB_EXPORT_3D_COMMAND exportPcbGlbCmd{ "glb", UTF8STDSTR( _( "Export GLB (binary GLTF)" ) ), JOB_EXPORT_PCB_3D::FORMAT::GLB };
static CLI::PCB_EXPORT_3D_COMMAND exportPcbStepCmd{ "step", UTF8STDSTR( _( "Export STEP" ) ), JOB_EXPORT_PCB_3D::FORMAT::STEP };
static CLI::PCB_EXPORT_3D_COMMAND exportPcbVrmlCmd{ "vrml", UTF8STDSTR( _( "Export VRML" ) ), JOB_EXPORT_PCB_3D::FORMAT::VRML };
static CLI::PCB_EXPORT_SVG_COMMAND exportPcbSvgCmd{};
static CLI::PCB_EXPORT_PDF_COMMAND exportPcbPdfCmd{};
static CLI::PCB_EXPORT_POS_COMMAND exportPcbPosCmd{};
@ -145,11 +145,11 @@ static CLI::SCH_ERC_COMMAND schErcCmd{};
static CLI::SCH_EXPORT_BOM_COMMAND exportSchBomCmd{};
static CLI::SCH_EXPORT_PYTHONBOM_COMMAND exportSchPythonBomCmd{};
static CLI::SCH_EXPORT_NETLIST_COMMAND exportSchNetlistCmd{};
static CLI::SCH_EXPORT_PLOT_COMMAND exportSchDxfCmd{ "dxf", PLOT_FORMAT::DXF };
static CLI::SCH_EXPORT_PLOT_COMMAND exportSchHpglCmd{ "hpgl", PLOT_FORMAT::HPGL };
static CLI::SCH_EXPORT_PLOT_COMMAND exportSchPdfCmd{ "pdf", PLOT_FORMAT::PDF, false };
static CLI::SCH_EXPORT_PLOT_COMMAND exportSchPostscriptCmd{ "ps", PLOT_FORMAT::POST };
static CLI::SCH_EXPORT_PLOT_COMMAND exportSchSvgCmd{ "svg", PLOT_FORMAT::SVG };
static CLI::SCH_EXPORT_PLOT_COMMAND exportSchDxfCmd{ "dxf", UTF8STDSTR( _( "Export DXF" ) ), PLOT_FORMAT::DXF };
static CLI::SCH_EXPORT_PLOT_COMMAND exportSchHpglCmd{ "hpgl", UTF8STDSTR( _( "Export HPGL" ) ), PLOT_FORMAT::HPGL };
static CLI::SCH_EXPORT_PLOT_COMMAND exportSchPdfCmd{ "pdf", UTF8STDSTR( _( "Export PDF" ) ), PLOT_FORMAT::PDF, false };
static CLI::SCH_EXPORT_PLOT_COMMAND exportSchPostscriptCmd{ "ps", UTF8STDSTR( _( "Export PS" ) ), PLOT_FORMAT::POST };
static CLI::SCH_EXPORT_PLOT_COMMAND exportSchSvgCmd{ "svg", UTF8STDSTR( _( "Export SVG" ) ), PLOT_FORMAT::SVG };
static CLI::FP_COMMAND fpCmd{};
static CLI::FP_EXPORT_COMMAND fpExportCmd{};
static CLI::FP_EXPORT_SVG_COMMAND fpExportSvgCmd{};