pm_include.hpp File Reference

Defination File for Project Manager. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	PROGRAM_NAME   "Project Documentation Manager"
	Unique Program Identifier.
#define	DOCUMENTATION_ADDRESS   "https://www.little-sense.au/projects/BRIGADOON-0002"
	URL of Online Project Documentation.
#define	INCONJUNCTION_GROUP   "None"
	The Abbreviation Name of the Collaboration Group.
#define	PROJECT_IDENTIFIER   "BRIGADOON-0002"
	Unique Project Identifier.
#define	VERSION_STRING   "00.00.01"
#define	PROGRAM_DOCUMENTATION_LICENCE   "CC-BY-4.0"
	Project Documentation Release Licence.
#define	PROGRAM_SOFTWARE_LICENCE   "GPL-3.0-or-later"
	Project Software Release Licence.
#define	PROGRAM_HARDWARE_LICENCE   "Not Applicable"
	Project Hardware Release Licence.
#define	COPYRIGHT_STATEMENT   "Copyright © 2025-2025 by Brigadoon"
	Overall Claim of Ownership.
#define	CONTACT_NAME   "Mark"
	The name(s) of the Project's Contact.
#define	CONTACT_EMAIL   "river-drifter@aussiebroadband.com.au"
	The contact email for the Project's Developers.
#define	PROJECT_WEBSITE   "https://www.little-sense.au"
	The name(s) of the Developer's Website.

Detailed Description

Defination File for Project Manager.

This file is used to pass definitions from the Project Manager program into the program under development. Typical examples would be to change names or add/remove sections of code based on the settings in the Project Manager Program.

NOTE: This program must be added to the files so that the compiler will inculde it during compilation.

ONLY UPDATE THIS FILE IN THE PROJECT'S AUTOSRC DIRECTORY OTHERWISE CHANGES WILL BE LOST.

IF USING QTCREATOR AND THIS FILE IS ALTERED AND UPDATED INTO THE SOURCE DIRECTORY, CLEAN THE PROJECT TO ENSURE THAT THE SOURCE COMPILES WITH THE NEW PM_INCLUDE FILE.

Definition in file pm_include.hpp.

Macro Definition Documentation

CONTACT_EMAIL

#define CONTACT_EMAIL   "river-drifter@aussiebroadband.com.au"

The contact email for the Project's Developers.

This parameter is automaticall y set by the project Manager to ensure that it always matches the project documentation it controls.

Definition at line 104 of file pm_include.hpp.

Referenced by ProgramIdentification::LoadProgramIdentification().

CONTACT_NAME

#define CONTACT_NAME   "Mark"

The name(s) of the Project's Contact.

This parameter is automatically set by the project Manager to ensure that it always matches the project documentation it controls.

Definition at line 95 of file pm_include.hpp.

Referenced by ProgramIdentification::LoadProgramIdentification().

COPYRIGHT_STATEMENT

#define COPYRIGHT_STATEMENT   "Copyright © 2025-2025 by Brigadoon"

Overall Claim of Ownership.

Definition at line 86 of file pm_include.hpp.

Referenced by ProgramIdentification::LoadProgramIdentification().

DOCUMENTATION_ADDRESS

#define DOCUMENTATION_ADDRESS   "https://www.little-sense.au/projects/BRIGADOON-0002"

URL of Online Project Documentation.

This parameter is automatically set by the project Manager to ensure that it always matches the project documentation it controls.

Definition at line 37 of file pm_include.hpp.

INCONJUNCTION_GROUP

#define INCONJUNCTION_GROUP   "None"

The Abbreviation Name of the Collaboration Group.

This parameter is automaticall y set by the project Manager to ensure that it always matches the project documentation it controls.

Definition at line 46 of file pm_include.hpp.

PROGRAM_DOCUMENTATION_LICENCE

#define PROGRAM_DOCUMENTATION_LICENCE   "CC-BY-4.0"

Project Documentation Release Licence.

Definition at line 68 of file pm_include.hpp.

Referenced by ProgramIdentification::LoadProgramIdentification().

PROGRAM_HARDWARE_LICENCE

#define PROGRAM_HARDWARE_LICENCE   "Not Applicable"

Project Hardware Release Licence.

Definition at line 80 of file pm_include.hpp.

Referenced by ProgramIdentification::LoadProgramIdentification().

PROGRAM_NAME

#define PROGRAM_NAME   "Project Documentation Manager"

Unique Program Identifier.

This parameter is automatically set by the project Manager to ensure that it always matches the project documentation it controls.

Definition at line 28 of file pm_include.hpp.

PROGRAM_SOFTWARE_LICENCE

#define PROGRAM_SOFTWARE_LICENCE   "GPL-3.0-or-later"

Project Software Release Licence.

Definition at line 74 of file pm_include.hpp.

Referenced by ProgramIdentification::LoadProgramIdentification().

PROJECT_IDENTIFIER

#define PROJECT_IDENTIFIER   "BRIGADOON-0002"

Unique Project Identifier.

This parameter is automatically set by the project Manager to ensure that it always matches the project documentation it controls.

Definition at line 55 of file pm_include.hpp.

Referenced by ProgramIdentification::LoadProgramIdentification().

PROJECT_WEBSITE

#define PROJECT_WEBSITE   "https://www.little-sense.au"

The name(s) of the Developer's Website.

This parameter is automaticall y set by the project Manager to ensure that it always matches the project documentation it controls.

Definition at line 113 of file pm_include.hpp.

Referenced by ProgramIdentification::LoadProgramIdentification().

VERSION_STRING

#define VERSION_STRING   "00.00.01"

Definition at line 62 of file pm_include.hpp.

Referenced by ProgramIdentification::LoadProgramIdentification().