PROGRAM_INFORMATION Struct Reference

Information that is common to all Projects. More...

#include <common_definitions.h>

Data Fields
int	ProgramInformationIndex
QString	SiteName
QString	SiteURL
QString	SiteLogo
QString	SharedTemplateDirectory
QString	LocalDevelopmentDirectory
QString	ProjectPrefix
QString	PrimaryWebsiteDirectory
QString	PublisherName
QString	PublisherWebsite
QString	PublisherContactEmail
QString	ProjectListHeaderFilename
QString	ProjectListFooterFilename
QString	ProjectListLineFilename
QString	ProjectListWebpageFilename
QString	ProjectListOpenSimFilename
QString	DefaultReturnAddress
QString	DevelopmentDoxyDocDirectory
QString	CurrentUser
int	SuffixSize

Detailed Description

Information that is common to all Projects.

This structure contains information that is commonly used by all projects, such as the Name of the website holding the generated documentation and the location of the project templates.

Definition at line 407 of file common_definitions.h.

Field Documentation

CurrentUser

QString PROGRAM_INFORMATION::CurrentUser

The person currently using the Program

Definition at line 427 of file common_definitions.h.

Referenced by ProjectSubstitute::LoadFileSubsList(), and ReadProjectInfo::LoadProjectInfo().

DefaultReturnAddress

QString PROGRAM_INFORMATION::DefaultReturnAddress

URL to which Project Documentation exits to

Definition at line 425 of file common_definitions.h.

Referenced by ReadProjectInfo::LoadProjectInfo().

DevelopmentDoxyDocDirectory

QString PROGRAM_INFORMATION::DevelopmentDoxyDocDirectory

Directory where the Development Doxygen Document Files are held

Definition at line 426 of file common_definitions.h.

Referenced by ReadProjectInfo::LoadProjectInfo().

LocalDevelopmentDirectory

QString PROGRAM_INFORMATION::LocalDevelopmentDirectory

Directory where Local Development is held.

Definition at line 414 of file common_definitions.h.

Referenced by Worker::CountLines(), Worker::CreateSourceArchive(), Worker::FindLibraries(), ProjectSubstitute::LoadFileSubsList(), and ReadProjectInfo::LoadProjectInfo().

PrimaryWebsiteDirectory

QString PROGRAM_INFORMATION::PrimaryWebsiteDirectory

Primary Directory where Web site results are placed.

Definition at line 416 of file common_definitions.h.

Referenced by Worker::CppCheck(), Worker::CreateSourceArchive(), Worker::DoDoxygen(), ProjectSubstitute::LoadFileSubsList(), ReadProjectInfo::LoadProjectInfo(), Worker::PreProcessProject(), and DoxygenManager::ReceiveResult().

ProgramInformationIndex

int PROGRAM_INFORMATION::ProgramInformationIndex

Index of the Program Information.

Definition at line 409 of file common_definitions.h.

Referenced by ReadProjectInfo::LoadProjectInfo().

ProjectListFooterFilename

QString PROGRAM_INFORMATION::ProjectListFooterFilename

Filename of the Project List Footer

Definition at line 421 of file common_definitions.h.

Referenced by ReadProjectInfo::LoadProjectInfo().

ProjectListHeaderFilename

QString PROGRAM_INFORMATION::ProjectListHeaderFilename

Filename of the Project List Header

Definition at line 420 of file common_definitions.h.

Referenced by ReadProjectInfo::LoadProjectInfo().

ProjectListLineFilename

QString PROGRAM_INFORMATION::ProjectListLineFilename

Filename of the Project List Line

Definition at line 422 of file common_definitions.h.

Referenced by ReadProjectInfo::LoadProjectInfo().

ProjectListOpenSimFilename

QString PROGRAM_INFORMATION::ProjectListOpenSimFilename

Filename of the Project List OPen Simulator Page

Definition at line 424 of file common_definitions.h.

ProjectListWebpageFilename

QString PROGRAM_INFORMATION::ProjectListWebpageFilename

Filename of the Project List Web Page

Definition at line 423 of file common_definitions.h.

ProjectPrefix

QString PROGRAM_INFORMATION::ProjectPrefix

Project text Profix to the Project Ident

Definition at line 415 of file common_definitions.h.

Referenced by ReadProjectInfo::LoadProjectInfo().

PublisherContactEmail

QString PROGRAM_INFORMATION::PublisherContactEmail

Publisher's Contact's Email Address

Definition at line 419 of file common_definitions.h.

Referenced by ProjectSubstitute::LoadFileSubsList(), and ReadProjectInfo::LoadProjectInfo().

PublisherName

QString PROGRAM_INFORMATION::PublisherName

Publisher, Name

Definition at line 417 of file common_definitions.h.

Referenced by ProjectSubstitute::LoadFileSubsList(), and ReadProjectInfo::LoadProjectInfo().

PublisherWebsite

QString PROGRAM_INFORMATION::PublisherWebsite

Publisher's URL

Definition at line 418 of file common_definitions.h.

Referenced by ProjectSubstitute::LoadFileSubsList(), and ReadProjectInfo::LoadProjectInfo().

SharedTemplateDirectory

QString PROGRAM_INFORMATION::SharedTemplateDirectory

Location of the Template Directory

Definition at line 413 of file common_definitions.h.

Referenced by ProjectSubstitute::LoadFileSubsList(), ReadProjectInfo::LoadProjectInfo(), and DoxygenManager::ReceiveResult().

SiteLogo

QString PROGRAM_INFORMATION::SiteLogo

Pointer to the Destination Web Site's Logo

Definition at line 412 of file common_definitions.h.

Referenced by ProjectSubstitute::LoadFileSubsList(), and ReadProjectInfo::LoadProjectInfo().

SiteName

QString PROGRAM_INFORMATION::SiteName

Destination Web Site Name

Definition at line 410 of file common_definitions.h.

Referenced by ProjectSubstitute::LoadFileSubsList(), and ReadProjectInfo::LoadProjectInfo().

SiteURL

QString PROGRAM_INFORMATION::SiteURL

URL of the Destination Web Site

Definition at line 411 of file common_definitions.h.

Referenced by ProjectSubstitute::LoadFileSubsList(), ReadProjectInfo::LoadProjectInfo(), ProjectListManager::MakeHTMLProjectPage(), and ProjectListManager::MakeOSProjectPage().

SuffixSize

int PROGRAM_INFORMATION::SuffixSize

Number of digits in the number part of the Project Ident.

Definition at line 428 of file common_definitions.h.

Referenced by ReadProjectInfo::LoadProjectInfo().

---

The documentation for this struct was generated from the following file:

• common_definitions.h