Skip to content

Commit

Permalink
#11:
Browse files Browse the repository at this point in the history
 - Add extra namespace filters to SHFB project
 - Fix a whole lot of documentation warnings as reported by SHFB
  • Loading branch information
jumpinjackie committed Feb 2, 2017
1 parent b10a392 commit 8d61763
Show file tree
Hide file tree
Showing 27 changed files with 335 additions and 157 deletions.
2 changes: 2 additions & 0 deletions Doc/MaestroAPI.shfbproj
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
<Filter entryType="Namespace" fullName="OSGeo.MapGuide.ObjectModels.MapDefinition.v2_4_0" isExposed="False" />
<Filter entryType="Namespace" fullName="OSGeo.MapGuide.ObjectModels.PrintLayout.v1_0_0" isExposed="False" />
<Filter entryType="Namespace" fullName="OSGeo.MapGuide.ObjectModels.RuntimeMap.v2_6_0" isExposed="False" />
<Filter entryType="Namespace" fullName="OSGeo.MapGuide.ObjectModels.RuntimeMap.v3_0_0" isExposed="False" />
<Filter entryType="Namespace" fullName="OSGeo.MapGuide.ObjectModels.SymbolDefinition.v1_0_0" isExposed="False" />
<Filter entryType="Namespace" fullName="OSGeo.MapGuide.ObjectModels.SymbolDefinition.v1_1_0" isExposed="False" />
<Filter entryType="Namespace" fullName="OSGeo.MapGuide.ObjectModels.SymbolDefinition.v2_4_0" isExposed="False" />
Expand All @@ -79,6 +80,7 @@
<Filter entryType="Namespace" fullName="OSGeo.MapGuide.ObjectModels.WebLayout.v1_1_0" isExposed="False" />
<Filter entryType="Namespace" fullName="OSGeo.MapGuide.ObjectModels.WebLayout.v2_4_0" isExposed="False" />
<Filter entryType="Namespace" fullName="OSGeo.MapGuide.ObjectModels.WebLayout.v2_6_0" isExposed="False" />
<Filter entryType="Namespace" fullName="OSGeo.MapGuide.ObjectModels.TileSetDefinition.v3_0_0" isExposed="False" />
</ApiFilter>
<SdkLinkType>None</SdkLinkType>
<FeedbackEMailAddress>jumpinjackie%40gmail.com</FeedbackEMailAddress>
Expand Down
13 changes: 13 additions & 0 deletions Maestro.Base/Editor/DrawingSourceEditor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ namespace Maestro.Base.Editor
/// </remarks>
public partial class DrawingSourceEditor : EditorContentBase
{
/// <summary>
/// Constructor
/// </summary>
public DrawingSourceEditor()
{
InitializeComponent();
Expand All @@ -46,6 +49,16 @@ public DrawingSourceEditor()

private bool _init = false;

/// <summary>
/// Binds the specified resource to this control. This effectively initializes
/// all the fields in this control and sets up databinding on all fields. All
/// subclasses *must* override this method.
///
/// Also note that this method may be called more than once (e.g. Returning from
/// and XML edit of this resource). Thus subclasses must take this scenario into
/// account when implementing
/// </summary>
/// <param name="service">The editor service</param>
protected override void Bind(IEditorService service)
{
if (!_init)
Expand Down
6 changes: 3 additions & 3 deletions Maestro.Base/Editor/EditorContentBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ private void OnSessionIdChanged(object sender, EventArgs e)
/// <summary>
/// Gets the XML content of the edited resource
/// </summary>
/// <returns></returns>
/// <returns>The XML content</returns>
public virtual string GetXmlContent()
{
using (var sr = new System.IO.StreamReader(ObjectFactory.Serialize(this.Resource)))
Expand Down Expand Up @@ -288,7 +288,7 @@ private void OnDirtyStateChanged(object sender, EventArgs e)
/// and XML edit of this resource). Thus subclasses must take this scenario into
/// account when implementing
/// </summary>
/// <param name="service"></param>
/// <param name="service">The editor service</param>
protected virtual void Bind(IEditorService service)
{
throw new NotImplementedException();
Expand Down Expand Up @@ -342,7 +342,7 @@ public bool IsNew
}

/// <summary>
/// Gets whether this resource can be previewed
/// Gets whether this resource can be profiled
/// </summary>
public virtual bool CanProfile
{
Expand Down
16 changes: 16 additions & 0 deletions Maestro.Base/Editor/FeatureSourceEditor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ namespace Maestro.Base.Editor
/// </remarks>
public partial class FeatureSourceEditor : EditorContentBase
{
/// <summary>
/// Constructor
/// </summary>
public FeatureSourceEditor()
{
InitializeComponent();
Expand All @@ -52,6 +55,16 @@ public FeatureSourceEditor()
private IEditorService _edsvc;
private bool _init = false;

/// <summary>
/// Binds the specified resource to this control. This effectively initializes
/// all the fields in this control and sets up databinding on all fields. All
/// subclasses *must* override this method.
///
/// Also note that this method may be called more than once (e.g. Returning from
/// and XML edit of this resource). Thus subclasses must take this scenario into
/// account when implementing
/// </summary>
/// <param name="service">The editor service</param>
protected override void Bind(IEditorService service)
{
if (!_init)
Expand Down Expand Up @@ -121,6 +134,9 @@ protected override void OnBeforeSave(object sender, CancelEventArgs e)
base.OnBeforeSave(sender, e);
}

/// <summary>
/// Gets whether this resource can be profiled
/// </summary>
public override bool CanProfile
{
get
Expand Down
13 changes: 13 additions & 0 deletions Maestro.Base/Editor/FusionEditor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ namespace Maestro.Base.Editor
/// </remarks>
public partial class FusionEditor : EditorContentBase
{
/// <summary>
/// Constructor
/// </summary>
public FusionEditor()
{
InitializeComponent();
Expand All @@ -47,6 +50,16 @@ public FusionEditor()
private IEditorService _edsvc;
private bool _init = false;

/// <summary>
/// Binds the specified resource to this control. This effectively initializes
/// all the fields in this control and sets up databinding on all fields. All
/// subclasses *must* override this method.
///
/// Also note that this method may be called more than once (e.g. Returning from
/// and XML edit of this resource). Thus subclasses must take this scenario into
/// account when implementing
/// </summary>
/// <param name="service">The editor service</param>
protected override void Bind(IEditorService service)
{
if (!_init)
Expand Down
2 changes: 1 addition & 1 deletion Maestro.Base/Editor/IEditorFactory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public interface IEditorFactory
/// <summary>
/// Creates an instance of this resource editor
/// </summary>
/// <returns></returns>
/// <returns>The editor instance</returns>
IEditorViewContent Create();
}

Expand Down
2 changes: 1 addition & 1 deletion Maestro.Base/Editor/IEditorViewContent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public interface IEditorViewContent : IViewContent
/// <summary>
/// Gets the XML content of the edited resource
/// </summary>
/// <returns></returns>
/// <returns>The XML content</returns>
string GetXmlContent();

/// <summary>
Expand Down
16 changes: 16 additions & 0 deletions Maestro.Base/Editor/LayerDefinitionEditor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ namespace Maestro.Base.Editor
/// </remarks>
public partial class LayerDefinitionEditor : EditorContentBase
{
/// <summary>
/// Constructor
/// </summary>
public LayerDefinitionEditor()
{
InitializeComponent();
Expand All @@ -54,6 +57,16 @@ public LayerDefinitionEditor()
private IEditorService _edsvc;
private bool _init = false;

/// <summary>
/// Binds the specified resource to this control. This effectively initializes
/// all the fields in this control and sets up databinding on all fields. All
/// subclasses *must* override this method.
///
/// Also note that this method may be called more than once (e.g. Returning from
/// and XML edit of this resource). Thus subclasses must take this scenario into
/// account when implementing
/// </summary>
/// <param name="service">The editor service</param>
protected override void Bind(Maestro.Editors.IEditorService service)
{
if (!_init)
Expand Down Expand Up @@ -141,6 +154,9 @@ protected override void OnBeforeSave(object sender, CancelEventArgs e)
base.OnBeforeSave(sender, e);
}

/// <summary>
/// Gets whether this resource can be profiled
/// </summary>
public override bool CanProfile
{
get
Expand Down
13 changes: 13 additions & 0 deletions Maestro.Base/Editor/LoadProcedureEditor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,24 @@ namespace Maestro.Base.Editor
/// </remarks>
public partial class LoadProcedureEditor : EditorContentBase
{
/// <summary>
/// Constructor
/// </summary>
public LoadProcedureEditor()
{
InitializeComponent();
}

/// <summary>
/// Binds the specified resource to this control. This effectively initializes
/// all the fields in this control and sets up databinding on all fields. All
/// subclasses *must* override this method.
///
/// Also note that this method may be called more than once (e.g. Returning from
/// and XML edit of this resource). Thus subclasses must take this scenario into
/// account when implementing
/// </summary>
/// <param name="service">The editor service</param>
protected override void Bind(Maestro.Editors.IEditorService service)
{
panelBody.Controls.Clear();
Expand Down
16 changes: 16 additions & 0 deletions Maestro.Base/Editor/MapDefinitionEditor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ namespace Maestro.Base.Editor
/// </remarks>
public partial class MapDefinitionEditor : EditorContentBase
{
/// <summary>
/// Constructor
/// </summary>
public MapDefinitionEditor()
{
InitializeComponent();
Expand All @@ -51,6 +54,16 @@ public MapDefinitionEditor()
private IEditorService _edsvc;
private bool _init = false;

/// <summary>
/// Binds the specified resource to this control. This effectively initializes
/// all the fields in this control and sets up databinding on all fields. All
/// subclasses *must* override this method.
///
/// Also note that this method may be called more than once (e.g. Returning from
/// and XML edit of this resource). Thus subclasses must take this scenario into
/// account when implementing
/// </summary>
/// <param name="service">The editor service</param>
protected override void Bind(IEditorService service)
{
if (!_init)
Expand Down Expand Up @@ -106,6 +119,9 @@ protected override void OnBeforeSave(object sender, CancelEventArgs e)
base.OnBeforeSave(sender, e);
}

/// <summary>
/// Gets whether this resource can be profiled
/// </summary>
public override bool CanProfile
{
get
Expand Down
13 changes: 13 additions & 0 deletions Maestro.Base/Editor/PrintLayoutEditor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,24 @@ namespace Maestro.Base.Editor
/// </remarks>
public partial class PrintLayoutEditor : EditorContentBase
{
/// <summary>
/// Constructor
/// </summary>
public PrintLayoutEditor()
{
InitializeComponent();
}

/// <summary>
/// Binds the specified resource to this control. This effectively initializes
/// all the fields in this control and sets up databinding on all fields. All
/// subclasses *must* override this method.
///
/// Also note that this method may be called more than once (e.g. Returning from
/// and XML edit of this resource). Thus subclasses must take this scenario into
/// account when implementing
/// </summary>
/// <param name="service">The editor service</param>
protected override void Bind(Maestro.Editors.IEditorService service)
{
panelBody.Controls.Clear();
Expand Down
13 changes: 13 additions & 0 deletions Maestro.Base/Editor/SymbolDefinitionEditor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,24 @@ namespace Maestro.Base.Editor
/// </remarks>
public partial class SymbolDefinitionEditor : EditorContentBase
{
/// <summary>
/// Constructor
/// </summary>
public SymbolDefinitionEditor()
{
InitializeComponent();
}

/// <summary>
/// Binds the specified resource to this control. This effectively initializes
/// all the fields in this control and sets up databinding on all fields. All
/// subclasses *must* override this method.
///
/// Also note that this method may be called more than once (e.g. Returning from
/// and XML edit of this resource). Thus subclasses must take this scenario into
/// account when implementing
/// </summary>
/// <param name="service">The editor service</param>
protected override void Bind(Maestro.Editors.IEditorService service)
{
panelBody.Controls.Clear();
Expand Down
10 changes: 10 additions & 0 deletions Maestro.Base/Editor/TileSetEditor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,16 @@ public TileSetEditor()
InitializeComponent();
}

/// <summary>
/// Binds the specified resource to this control. This effectively initializes
/// all the fields in this control and sets up databinding on all fields. All
/// subclasses *must* override this method.
///
/// Also note that this method may be called more than once (e.g. Returning from
/// and XML edit of this resource). Thus subclasses must take this scenario into
/// account when implementing
/// </summary>
/// <param name="service">The editor service</param>
protected override void Bind(Editors.IEditorService service)
{
panelBody.Controls.Clear();
Expand Down
13 changes: 13 additions & 0 deletions Maestro.Base/Editor/WatermarkDefinitionEditor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ namespace Maestro.Base.Editor
/// </remarks>
public partial class WatermarkDefinitionEditor : EditorContentBase
{
/// <summary>
/// Constructor
/// </summary>
public WatermarkDefinitionEditor()
{
InitializeComponent();
Expand All @@ -47,6 +50,16 @@ public WatermarkDefinitionEditor()
private IEditorService _edsvc;
private bool _init = false;

/// <summary>
/// Binds the specified resource to this control. This effectively initializes
/// all the fields in this control and sets up databinding on all fields. All
/// subclasses *must* override this method.
///
/// Also note that this method may be called more than once (e.g. Returning from
/// and XML edit of this resource). Thus subclasses must take this scenario into
/// account when implementing
/// </summary>
/// <param name="service">The editor service</param>
protected override void Bind(Maestro.Editors.IEditorService service)
{
if (!_init)
Expand Down
13 changes: 13 additions & 0 deletions Maestro.Base/Editor/WebLayoutEditor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,24 @@ namespace Maestro.Base.Editor
/// </remarks>
public partial class WebLayoutEditor : EditorContentBase
{
/// <summary>
/// Constructor
/// </summary>
public WebLayoutEditor()
{
InitializeComponent();
}

/// <summary>
/// Binds the specified resource to this control. This effectively initializes
/// all the fields in this control and sets up databinding on all fields. All
/// subclasses *must* override this method.
///
/// Also note that this method may be called more than once (e.g. Returning from
/// and XML edit of this resource). Thus subclasses must take this scenario into
/// account when implementing
/// </summary>
/// <param name="service">The editor service</param>
protected override void Bind(Maestro.Editors.IEditorService service)
{
panelBody.Controls.Clear();
Expand Down
13 changes: 13 additions & 0 deletions Maestro.Base/Editor/XmlEditor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ namespace Maestro.Base.Editor
/// </remarks>
public partial class XmlEditor : EditorContentBase
{
/// <summary>
/// Constructor
/// </summary>
public XmlEditor()
{
InitializeComponent();
Expand All @@ -68,6 +71,16 @@ private void ValidateXml(out string[] errors, out string[] warnings)

private IEditorService _edSvc;

/// <summary>
/// Binds the specified resource to this control. This effectively initializes
/// all the fields in this control and sets up databinding on all fields. All
/// subclasses *must* override this method.
///
/// Also note that this method may be called more than once (e.g. Returning from
/// and XML edit of this resource). Thus subclasses must take this scenario into
/// account when implementing
/// </summary>
/// <param name="service">The editor service</param>
protected override void Bind(IEditorService service)
{
//NOTE: This is exempt from #1656 requirements because this will never be called when returing
Expand Down
Loading

0 comments on commit 8d61763

Please sign in to comment.