Skip to content

Commit

Permalink
Fixed broken Xml documentation and ported DocFX project to latest ver…
Browse files Browse the repository at this point in the history
…sion.

- Removed the customized documentation styles.
- This fixes the broken styles and scripts in the current documentation.
  • Loading branch information
paulushub committed Oct 15, 2023
1 parent acd64b9 commit e54d7e4
Show file tree
Hide file tree
Showing 60 changed files with 657 additions and 9,316 deletions.
3 changes: 0 additions & 3 deletions Source/SharpVectorConvertersWpf/SvgBitmap.cs
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,6 @@ public string AppName
/// The file can be located on a computer, network or assembly resources.
/// Settings this to <see langword="null"/> will close any opened diagram.
/// </value>
/// <remarks>
/// This is the same as the <see cref="Source"/> property, and added for consistency.
/// </remarks>
/// <seealso cref="SvgSource"/>
public Uri UriSource
{
Expand Down
22 changes: 11 additions & 11 deletions Source/SharpVectorCore/Css/ICssStyleSheet.cs
Original file line number Diff line number Diff line change
Expand Up @@ -50,17 +50,17 @@ ICssRuleList CssRules
get;
}

/// <summary>
/// If this style sheet comes from an <c>@import</c> rule, the ownerRule attribute will
/// contain the <see cref="ICssImportRule"/>.
/// </summary>
/// <remarks>
/// In that case, the <see cref="OwnerNode"/> attribute in the <see cref="IStyleSheet"/> interface
/// will be <see langword="null"/>. If the style sheet comes from an element or a processing instruction,
/// the <c>OwnerRule</c> attribute will be <see langword="null"/> and the <see cref="OwnerNode"/>
/// attribute will contain the node.
/// </remarks>
ICssRule OwnerRule
/// <summary>
/// If this style sheet comes from an <c>@import</c> rule, the ownerRule attribute will
/// contain the <see cref="ICssImportRule"/>.
/// </summary>
/// <remarks>
/// In that case, the <see cref="IStyleSheet.OwnerNode"/> attribute in the <see cref="IStyleSheet"/> interface
/// will be <see langword="null"/>. If the style sheet comes from an element or a processing instruction,
/// the <c>OwnerRule</c> attribute will be <see langword="null"/> and the <see cref="IStyleSheet.OwnerNode"/>
/// attribute will contain the node.
/// </remarks>
ICssRule OwnerRule
{
get;
}
Expand Down
9 changes: 0 additions & 9 deletions Source/SharpVectorCore/Events/DomEvent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,6 @@ namespace SharpVectors.Dom.Events
/// <para>
/// Copying a <see cref="INode">INode</see> does not copy the event listeners attached to it. Event listeners
/// must be attached to the newly created <see cref="INode">INode</see> afterwards if so desired.
/// Therefore, <see cref="INode">INode</see>s are copied using <see cref="IXmlNode.CloneNode">INode.CloneNode</see> or
/// <see cref="IRange.CloneContents">IRange.CloneContents</see>, the <see cref="EventListener">EventListener</see>s
/// attached to the source <see cref="INode">INode</see>s are not attached to their copies.
/// </para>
/// <para>
/// Moving a <see cref="INode">INode</see> does not affect the event listeners attached to it. Therefore, when
/// <see cref="INode">INode</see>s are moved using <see cref="IDocument.AdoptNode">IDocument.AdoptNode</see>,
/// <see cref="IXmlNode.AppendChild">INode.AppendChild</see>, or <see cref="IRange.ExtractContents">IRange.ExtractContents</see>, the
/// <see cref="EventListener">EventListener</see>s attached to the moved <see cref="INode">INode</see>s stay attached to them.
/// </para>
/// </remarks>
/// <paramref name="e">
Expand Down
15 changes: 2 additions & 13 deletions Source/SharpVectorCore/Events/IDocumentEvent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ public interface IDocumentEvent
{
#region Methods

#region DOM Level 2

/// <summary>
/// The <see cref="CreateEvent">CreateEvent</see> method is used in
/// creating <see cref="IEvent">IEvent</see>s when it is either
Expand Down Expand Up @@ -72,12 +70,7 @@ public interface IDocumentEvent
/// NOT_SUPPORTED_ERR: Raised if the implementation does not support
/// the <see cref="IEvent">Event</see> interface requested.
/// </exception>
IEvent CreateEvent(
string eventType);

#endregion

#region DOM Level 3 Experimental
IEvent CreateEvent(string eventType);

/// <summary>
/// Test if the implementation can generate events of a specified type.
Expand All @@ -95,11 +88,7 @@ IEvent CreateEvent(
/// <c>true</c> if the implementation can generate and dispatch this
/// event type, <c>false</c> otherwise.
/// </returns>
bool CanDispatch(
string namespaceUri,
string type);

#endregion
bool CanDispatch(string namespaceUri, string type);

#endregion
}
Expand Down
128 changes: 64 additions & 64 deletions Source/SharpVectorCore/Events/IMutationNameEvent.cs
Original file line number Diff line number Diff line change
@@ -1,74 +1,74 @@
namespace SharpVectors.Dom.Events
{
/// <summary>
/// The <see cref="IMutationNameEvent">IMutationNameEvent</see> interface
/// provides specific contextual information associated with Mutation
/// name event types.
/// </summary>
/// <remarks>
/// Note: To create an instance of the
/// <see cref="IMutationNameEvent">IMutationNameEvent</see> interface,
/// use the feature string <c>"MutationNameEvent"</c> as the value of the
/// input parameter used with the
/// <see cref="CreateEvent">CreateEvent</see> method of the
/// <see cref="IDocumentEvent">IDocumentEvent</see> interface.
/// </remarks>
public interface IMutationNameEvent
/// <summary>
/// The <see cref="IMutationNameEvent">IMutationNameEvent</see> interface
/// provides specific contextual information associated with Mutation
/// name event types.
/// </summary>
/// <remarks>
/// Note: To create an instance of the
/// <see cref="IMutationNameEvent">IMutationNameEvent</see> interface,
/// use the feature string <c>"MutationNameEvent"</c> as the value of the
/// input parameter used with the
/// <see cref="IDocumentEvent.CreateEvent">CreateEvent</see> method of the
/// <see cref="IDocumentEvent">IDocumentEvent</see> interface.
/// </remarks>
public interface IMutationNameEvent
{
/// <summary>
/// The previous value of the
/// <see cref="RelatedNode">RelatedNode</see>'s namespace URI.
/// </summary>
string PrevNamespaceUri
/// <summary>
/// The previous value of the
/// <see cref="IMutationEvent.RelatedNode">RelatedNode</see>'s namespace URI.
/// </summary>
string PrevNamespaceUri
{
get;
}
/// <summary>
/// The previous value of the
/// <see cref="RelatedNode">RelatedNode</see>'s nodeName.
/// </summary>
string PrevNodeName

/// <summary>
/// The previous value of the
/// <see cref="IMutationEvent.RelatedNode">RelatedNode</see>'s nodeName.
/// </summary>
string PrevNodeName
{
get;
}
/// <summary>
/// The <see cref="InitMutationNameEvent">InitMutationNameEvent</see>
/// method is used to initialize the value of a
/// <see cref="IMutationNameEvent">IMutationNameEvent</see> created
/// using the
/// <see cref="IDocumentEvent.CreateEvent">IDocumentEvent.CreateEvent</see>
/// method. This method may only be called before the
/// <see cref="IMutationNameEvent">IMutationNameEvent</see> has been
/// dispatched via the
/// <see cref="IEventTarget.DispatchEvent">IEventTarget.DispatchEvent</see>
/// method, though it may be called multiple times during that phase
/// if necessary. If called multiple times, the final invocation
/// takes precedence.
/// </summary>
/// <param name="typeArg">
/// Specifies the event type.
/// </param>
/// <param name="canBubbleArg">
/// Specifies whether or not the event can bubble.
/// </param>
/// <param name="cancelableArg">
/// Specifies whether or not the event's default action can be prevented.
/// </param>
/// <param name="relatedNodeArg">
/// Specifies the <see cref="IEvent">IEvent</see>'s related Node.
/// </param>
/// <param name="prevNamespaceUri">
/// Specifies the previous <see cref="NamespaceUri">NamespaceUri</see>
/// of the related <see cref="INode">INode</see>. This value may be
/// <c>null</c>.
/// </param>
/// <param name="prevNodeName">
/// Specifies the previous <see cref="NodeName">NodeName</see> of the
/// related Node.
/// </param>
void InitMutationNameEvent(string typeArg, bool canBubbleArg, bool cancelableArg,

/// <summary>
/// The <see cref="InitMutationNameEvent">InitMutationNameEvent</see>
/// method is used to initialize the value of a
/// <see cref="IMutationNameEvent">IMutationNameEvent</see> created
/// using the
/// <see cref="IDocumentEvent.CreateEvent">IDocumentEvent.CreateEvent</see>
/// method. This method may only be called before the
/// <see cref="IMutationNameEvent">IMutationNameEvent</see> has been
/// dispatched via the
/// <see cref="IEventTarget.DispatchEvent">IEventTarget.DispatchEvent</see>
/// method, though it may be called multiple times during that phase
/// if necessary. If called multiple times, the final invocation
/// takes precedence.
/// </summary>
/// <param name="typeArg">
/// Specifies the event type.
/// </param>
/// <param name="canBubbleArg">
/// Specifies whether or not the event can bubble.
/// </param>
/// <param name="cancelableArg">
/// Specifies whether or not the event's default action can be prevented.
/// </param>
/// <param name="relatedNodeArg">
/// Specifies the <see cref="IEvent">IEvent</see>'s related Node.
/// </param>
/// <param name="prevNamespaceUri">
/// Specifies the previous <see cref="IXmlNode.NamespaceURI">NamespaceUri</see>
/// of the related <see cref="INode">INode</see>. This value may be
/// <c>null</c>.
/// </param>
/// <param name="prevNodeName">
/// Specifies the previous <see cref="IXmlNode.Name">NodeName</see> of the
/// related Node.
/// </param>
void InitMutationNameEvent(string typeArg, bool canBubbleArg, bool cancelableArg,
INode relatedNodeArg, string prevNamespaceUri, string prevNodeName);

/// <summary>
Expand Down Expand Up @@ -104,11 +104,11 @@ void InitMutationNameEvent(string typeArg, bool canBubbleArg, bool cancelableArg
/// </param>
/// <param name="prevNamespaceUri">
/// Specifies the previous
/// <see cref="INode.NamespaceUri">NamespaceUri</see> of the related
/// <see cref="IXmlNode.NamespaceURI">NamespaceUri</see> of the related
/// Node. This value may be <c>null</c>.
/// </param>
/// <param name="prevNodeName">
/// Specifies the previous <see cref="INode.NodeName">NodeName</see>
/// Specifies the previous <see cref="IXmlNode.Name">NodeName</see>
/// of the related Node.
/// </param>
void InitMutationNameEventNs(string namespaceUri, string typeArg, bool canBubbleArg,
Expand Down
2 changes: 1 addition & 1 deletion Source/SharpVectorCore/ICharacterData.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public interface ICharacterData : INode
/// </summary>
/// <param name="offset">The position within the string to start replacing.</param>
/// <param name="count">The number of characters to replace.</param>
/// <param name="strData"The new data that replaces the old string data.></param>
/// <param name="strData">The new data that replaces the old string data.</param>
void ReplaceData(int offset, int count, string strData);

/// <summary>Retrieves a substring of the full string from the specified range.</summary>
Expand Down
1 change: 1 addition & 0 deletions Source/SharpVectorCore/IDocumentType.cs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System;
using System.Xml;

namespace SharpVectors.Dom
Expand Down
4 changes: 2 additions & 2 deletions Source/SharpVectorCore/IDomImplementation.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public interface IDomImplementation
/// <param name="qualifiedName"> qualified name of the document type to be created. </param>
/// <param name="publicId"> external subset public identifier. </param>
/// <param name="systemId"> external subset system identifier. </param>
/// <returns> A new <see cref="IDocumentType"/> node with <see cref="INode.OwnerDocument"/>
/// <returns> A new <see cref="IDocumentType"/> node with <see cref="IXmlNode.OwnerDocument"/>
/// set to <see langword="null"/>. </returns>
/// <exception cref="DomException">
/// INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.
Expand All @@ -53,7 +53,7 @@ public interface IDomImplementation
/// <param name="namespaceURI"> namespace URI of the document element to create. </param>
/// <param name="qualifiedName"> qualified name of the document element to be created. </param>
/// <param name="doctype"> type of document to be created or <see langword="null"/>.
/// When <paramref name="doctype"/> is not <see langword="null"/>, its <see cref="INode.OwnerDocument"/>
/// When <paramref name="doctype"/> is not <see langword="null"/>, its <see cref="IXmlNode.OwnerDocument"/>
/// attribute is set to the document being created.
/// </param>
/// <returns> A new <see cref="IDocument"/> object. </returns>
Expand Down
2 changes: 1 addition & 1 deletion Source/SharpVectorCore/IElement.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ namespace SharpVectors.Dom
/// fairly complex sub-tree representing the attribute value. On the other
/// hand, in HTML, where all attributes have simple string values, methods to
/// directly access an attribute value can safely be used as a convenience.In
/// DOM Level 2, the method <see cref="INode.Normalize"/> is inherited from the
/// DOM Level 2, the method <see cref="IXmlNode.Normalize"/> is inherited from the
/// <see cref="INode"/> interface where it was moved.
/// </remarks>
/// <seealso href="http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113">
Expand Down
6 changes: 3 additions & 3 deletions Source/SharpVectorCore/IEntity.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ namespace SharpVectors.Dom
/// declaration. <see cref="IEntity"/> declaration modeling has been left for a
/// later Level of the DOM specification.
/// <para>
/// Represents an entity declaration, such as <!ENTITY... >.
/// Represents an entity declaration, such as <c>&lt;!ENTITY... &gt;</c>.
/// </para>
/// </summary>
/// <remarks>
/// <para>The <see cref="INode.NodeName"/> attribute that is inherited from
/// <para>The <see cref="IXmlNode.Name"/> attribute that is inherited from
/// <see cref="INode"/> contains the name of the entity.
/// </para>
/// <para>An XML processor may choose to completely expand entities before the
Expand All @@ -36,7 +36,7 @@ namespace SharpVectors.Dom
/// <see cref="IEntity"/> nodes and all their descendants are readonly.
/// </para>
/// <para>An <see cref="IEntity"/> node does not have any parent. If the entity
/// contains an unbound namespace prefix, the <see cref="INode.NamespaceURI"/> of
/// contains an unbound namespace prefix, the <see cref="IXmlNode.NamespaceURI"/> of
/// the corresponding node in the <see cref="IEntity"/> node subtree is
/// <see langword="null"/>. The same is true for <see cref="IEntityReference"/>
/// nodes that refer to this entity, when they are created using the
Expand Down
6 changes: 3 additions & 3 deletions Source/SharpVectorCore/INode.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ namespace SharpVectors.Dom
/// While all objects implementing the <see cref="INode"/> interface expose methods for dealing with children,
/// not all objects implementing the <see cref="INode"/> interface may have children. For example, <see cref="IText"/>
/// nodes may not have children, and adding children to such nodes results in a <see cref="DomException"/> being raised.
/// <para>The attributes <see cref="NodeName"/>, <see cref="NodeValue"/> and <see cref="Attributes"/> are included
/// <para>The attributes <see cref="IXmlNode.Name"/>, <see cref="IXmlNode.Value"/> and <see cref="IXmlNode.Attributes"/> are included
/// as a mechanism to get at node information without casting down to the specific derived interface.
/// In cases where there is no obvious mapping of these attributes for a specific <see cref="NodeType"/>
/// (e.g., <see cref="NodeValue"/> for an <see cref="IElement"/> or <see cref="Attributes"/> for a <see cref="IComment"/>),
/// In cases where there is no obvious mapping of these attributes for a specific <see cref="IXmlNode.NodeType"/>
/// (e.g., <see cref="IXmlNode.Value"/> for an <see cref="IElement"/> or <see cref="IXmlNode.Attributes"/> for a <see cref="IComment"/>),
/// this returns <see langword="null"/>. Note that the specialized interfaces may contain additional and more
/// convenient mechanisms to get and set the relevant information.
/// </para>
Expand Down
2 changes: 1 addition & 1 deletion Source/SharpVectorCore/INotation.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace SharpVectors.Dom
/// declares, by name, the format of an unparsed entity (see section 4.7 of
/// the XML 1.0 specification ), or is used for formal declaration of
/// processing instruction targets (see section 2.6 of the XML 1.0
/// specification ). The <see cref="INode.NodeName"/> attribute inherited from
/// specification ). The <see cref="IXmlNode.Name"/> attribute inherited from
/// <see cref="INode"/> is set to the declared name of the notation.
/// <para>The DOM Level 1 does not support editing <see cref="INotation"/> nodes;
/// they are therefore readonly.
Expand Down
5 changes: 1 addition & 4 deletions Source/SharpVectorCore/IProcessingInstruction.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,14 @@ public interface IProcessingInstruction : INode
/// <value>The target of the processing instruction.</value>
/// <remarks>
/// The target of this processing instruction. XML defines this as being
/// the first token following the markup that begins the processing
/// instruction.
/// the first token following the markup that begins the processing instruction.
/// </remarks>
string Target { get; }

/// <summary>
/// Gets or sets the content of the processing instruction, excluding the target.
/// </summary>
/// <value>The content of the processing instruction, excluding the target.</value>
/// <remarks>
/// </remarks>
string Data { get; set; }
}
}
Loading

0 comments on commit e54d7e4

Please sign in to comment.