/// <summary>
/// Comprueba si se debe generar el documento de una estructura a partir de los parámetros seleccionados
/// </summary>
internal bool MustGenerateDocumentation(LanguageStructModel objItem, DocumentationParameters objParameters)
{
switch (objItem.Modifier)
{
case LanguageStructModel.ModifierType.Internal:
return(objParameters.ShowInternal);
case LanguageStructModel.ModifierType.Private:
return(objParameters.ShowPrivate);
case LanguageStructModel.ModifierType.Protected:
return(objParameters.ShowProtected);
case LanguageStructModel.ModifierType.ProtectedAndInternal:
return(objParameters.ShowProtected && objParameters.ShowInternal);
case LanguageStructModel.ModifierType.ProtectedOrInternal:
return(objParameters.ShowProtected || objParameters.ShowInternal);
case LanguageStructModel.ModifierType.Public:
return(objParameters.ShowPublic);
default:
return(true);
}
}
/// <summary>
/// Obtiene los parámetros de generación del documento
/// </summary>
private DocumentationParameters GetParametersDocuments()
{
DocumentationParameters objParameters = new DocumentationParameters();
// Asigna los valores del formulario
objProject.IDType = (ProjectDocumentationModel.DocumentationType)(cboDocumentType.SelectedID ?? 0);
// Graba la configuración de la documentación
SaveConfiguration();
// Devuelve los parámetros
return(objParameters);
}
/// <summary>
/// Comprueba si se debe generar un archivo para un espacio de nombres (es decir, si alguna de las estructuras
/// de ese espacio de nombres necesita un archivo de documentación)
/// </summary>
internal bool MustGenerateFile(NameSpaceGroupModel objGroup, DocumentationParameters objParameters)
{ // Comprueba si se debe generar documentación para alguno de los elementos del espacio de nombres
foreach (LanguageStructModel objStruct in objGroup.NameSpace.Items)
{
if (MustGenerateFile(objStruct, objParameters))
{
return(true);
}
}
// Si se ha llegado hasta aquí es porque no se debería generar
return(false);
}
/// <summary>
/// Obtiene los parámetros de generación del documento
/// </summary>
private DocumentationParameters GetParametersDocuments()
{
DocumentationParameters objParameters = new DocumentationParameters();
// Asigna los valores del formulario
objParameters.TemplateFileName = fnTemplate.FileName;
objParameters.IDType = (DocumentationParameters.DocumentationType)(cboDocumentType.SelectedID ?? 0);
// Inicializa los checkbox
objParameters.ShowPublic = chkShowPublic.Checked;
objParameters.ShowInternal = chkShowInternal.Checked;
objParameters.ShowProtected = chkShowProtected.Checked;
objParameters.ShowPrivate = chkShowPrivate.Checked;
// Graba la configuración de la documentación
Configuration.Save(fnSolution.FileName, pthTarget.PathName, objParameters);
// Devuelve los parámetros
return(objParameters);
}
/// <summary>
/// Graba los parámetros de configuración
/// </summary>
internal static void Save(string strSolutionFileName, string strOutputPath, DocumentationParameters objParameters)
{ // Ajusta los datos en memoria
SolutionFileName = strSolutionFileName;
OutputPath = strOutputPath;
Parameters = objParameters;
// Ajusta los datos de las propiedades
Properties.Settings.Default.Solution = strSolutionFileName;
Properties.Settings.Default.Output = strOutputPath;
Properties.Settings.Default.Template = Parameters.TemplateFileName;
Properties.Settings.Default.IDType = (int)Parameters.IDType;
Properties.Settings.Default.WithPublic = Parameters.ShowPublic;
Properties.Settings.Default.WithInternal = Parameters.ShowInternal;
Properties.Settings.Default.WithProtected = Parameters.ShowProtected;
Properties.Settings.Default.WithPrivate = Parameters.ShowPrivate;
// Graba la configuración
Properties.Settings.Default.Save();
}
/// <summary>
/// Comprueba si se debe generar un archivo de una estructura por los parámetros seleccionados por el usuario
/// </summary>
internal bool MustGenerateFile(LanguageStructModel objItem, DocumentationParameters objParameters)
{ // Comprueba si se debe generar
if (objItem.IDType == LanguageStructModel.StructType.NameSpace)
{
return(true);
}
else if (MustGenerateDocumentation(objItem, objParameters))
{ // Comprueba si hay alguna plantilla definida para este tipo en la colección
foreach (TemplateModel objTemplate in this)
{
if (objTemplate.IDStructType == objItem.IDType)
{
return(true);
}
}
}
// Si ha llegado hasta aquí es porque no se debe generar
return(false);
}
/// <summary>
/// Comprueba si se debe generar un archivo de una estructura por los parámetros seleccionados por el usuario
/// </summary>
internal bool MustGenerateFile(StructDocumentationModel structDocument, DocumentationParameters parameters)
{
// Comprueba si se debe generar
if (structDocument.Parent == null)
{
return(true);
}
else if (MustGenerateDocumentation(structDocument, parameters))
{
// Comprueba si hay alguna plantilla definida para este tipo en la colección
foreach (TemplateModel template in this)
{
if (template.NameStructType.EqualsIgnoreCase(structDocument.Type))
{
return(true);
}
}
}
// Si ha llegado hasta aquí es porque no se debe generar
return(false);
}
/// <summary>
/// Carga los parámetros de documentación
/// </summary>
internal static void Load()
{ // Carga los datos básicos
SolutionFileName = Properties.Settings.Default.Solution;
OutputPath = Properties.Settings.Default.Output;
// Carga los parámetros
Parameters = new DocumentationParameters();
Parameters.TemplateFileName = Properties.Settings.Default.Template;
Parameters.IDType = (DocumentationParameters.DocumentationType)Properties.Settings.Default.IDType;
Parameters.ShowPublic = Properties.Settings.Default.WithPublic;
Parameters.ShowInternal = Properties.Settings.Default.WithInternal;
Parameters.ShowProtected = Properties.Settings.Default.WithProtected;
Parameters.ShowPrivate = Properties.Settings.Default.WithPrivate;
// Normaliza los datos
if (OutputPath.IsEmpty())
{
OutputPath = System.IO.Path.Combine(Application.StartupPath, "Data\\Documents");
}
// Plantilla
if (Parameters.TemplateFileName.IsEmpty())
{
Parameters.TemplateFileName = System.IO.Path.Combine(Application.StartupPath, "Data\\Templates\\Templates.tpt");
}
}
internal AbstractFilesGenerator(DocumentationParameters objParameters, string strUrlBase)
{
Parameters = objParameters;
MLBuilderHelper = new Writers.MLBuilderHelper(MLBuilder, strUrlBase);
}
internal SimpleFilesGenerator(DocumentationParameters objParameters, string strUrlBase) : base(objParameters, strUrlBase)
{
}
/// <summary>
/// Comprueba si se debe generar el documento de una estructura a partir de su ámbito
/// </summary>
internal bool MustGenerateDocumentation(StructDocumentationModel structDocument, DocumentationParameters parameters)
{
switch (structDocument.Scope)
{
case StructDocumentationModel.ScopeType.Internal:
return(parameters.ShowInternal);
case StructDocumentationModel.ScopeType.Private:
return(parameters.ShowPrivate);
case StructDocumentationModel.ScopeType.Protected:
return(parameters.ShowProtected);
case StructDocumentationModel.ScopeType.Global:
return(true);
default:
return(parameters.ShowPublic);
}
}