Skip to content

Commit

Permalink
Fixed ExFor comments in ApiExamples (#362)
Browse files Browse the repository at this point in the history
  • Loading branch information
stdstring authored Apr 9, 2024
1 parent 904fabf commit 195d66e
Show file tree
Hide file tree
Showing 35 changed files with 305 additions and 306 deletions.
2 changes: 1 addition & 1 deletion Examples/ApiExamples/ApiExamples/ExBookmarks.cs
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public void Insert()
//ExFor:BookmarkCollection.Item(String)
//ExFor:BookmarkCollection.GetEnumerator
//ExFor:Range.Bookmarks
//ExFor:DocumentVisitor.VisitBookmarkStart
//ExFor:DocumentVisitor.VisitBookmarkStart
//ExFor:DocumentVisitor.VisitBookmarkEnd
//ExSummary:Shows how to add bookmarks and update their contents.
[Test] //ExSkip
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ public void BookmarkLevels()
//ExFor:BookmarksOutlineLevelCollection
//ExFor:BookmarksOutlineLevelCollection.Add(String, Int32)
//ExFor:BookmarksOutlineLevelCollection.Clear
//ExFor:BookmarksOutlineLevelCollection.Contains(System.String)
//ExFor:BookmarksOutlineLevelCollection.Contains(String)
//ExFor:BookmarksOutlineLevelCollection.Count
//ExFor:BookmarksOutlineLevelCollection.IndexOfKey(System.String)
//ExFor:BookmarksOutlineLevelCollection.Item(System.Int32)
//ExFor:BookmarksOutlineLevelCollection.Item(System.String)
//ExFor:BookmarksOutlineLevelCollection.Remove(System.String)
//ExFor:BookmarksOutlineLevelCollection.RemoveAt(System.Int32)
//ExFor:BookmarksOutlineLevelCollection.IndexOfKey(String)
//ExFor:BookmarksOutlineLevelCollection.Item(Int32)
//ExFor:BookmarksOutlineLevelCollection.Item(String)
//ExFor:BookmarksOutlineLevelCollection.Remove(String)
//ExFor:BookmarksOutlineLevelCollection.RemoveAt(Int32)
//ExFor:OutlineOptions.BookmarksOutlineLevels
//ExSummary:Shows how to set outline levels for bookmarks.
Document doc = new Document();
Expand Down
50 changes: 25 additions & 25 deletions Examples/ApiExamples/ApiExamples/ExBuildingBlocks.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,21 @@ public class ExBuildingBlocks : ApiExampleBase
{
//ExStart
//ExFor:Document.GlossaryDocument
//ExFor:BuildingBlocks.BuildingBlock
//ExFor:BuildingBlocks.BuildingBlock.#ctor(BuildingBlocks.GlossaryDocument)
//ExFor:BuildingBlocks.BuildingBlock.Accept(DocumentVisitor)
//ExFor:BuildingBlocks.BuildingBlock.Behavior
//ExFor:BuildingBlocks.BuildingBlock.Category
//ExFor:BuildingBlocks.BuildingBlock.Description
//ExFor:BuildingBlocks.BuildingBlock.FirstSection
//ExFor:BuildingBlocks.BuildingBlock.Gallery
//ExFor:BuildingBlocks.BuildingBlock.Guid
//ExFor:BuildingBlocks.BuildingBlock.LastSection
//ExFor:BuildingBlocks.BuildingBlock.Name
//ExFor:BuildingBlocks.BuildingBlock.Sections
//ExFor:BuildingBlocks.BuildingBlock.Type
//ExFor:BuildingBlocks.BuildingBlockBehavior
//ExFor:BuildingBlocks.BuildingBlockType
//ExFor:BuildingBlock
//ExFor:BuildingBlock.#ctor(GlossaryDocument)
//ExFor:BuildingBlock.Accept(DocumentVisitor)
//ExFor:BuildingBlock.Behavior
//ExFor:BuildingBlock.Category
//ExFor:BuildingBlock.Description
//ExFor:BuildingBlock.FirstSection
//ExFor:BuildingBlock.Gallery
//ExFor:BuildingBlock.Guid
//ExFor:BuildingBlock.LastSection
//ExFor:BuildingBlock.Name
//ExFor:BuildingBlock.Sections
//ExFor:BuildingBlock.Type
//ExFor:BuildingBlockBehavior
//ExFor:BuildingBlockType
//ExSummary:Shows how to add a custom building block to a document.
[Test] //ExSkip
public void CreateAndInsert()
Expand Down Expand Up @@ -132,16 +132,16 @@ public override VisitorAction VisitBuildingBlockEnd(BuildingBlock block)
//ExEnd

//ExStart
//ExFor:BuildingBlocks.GlossaryDocument
//ExFor:BuildingBlocks.GlossaryDocument.Accept(DocumentVisitor)
//ExFor:BuildingBlocks.GlossaryDocument.BuildingBlocks
//ExFor:BuildingBlocks.GlossaryDocument.FirstBuildingBlock
//ExFor:BuildingBlocks.GlossaryDocument.GetBuildingBlock(BuildingBlocks.BuildingBlockGallery,System.String,System.String)
//ExFor:BuildingBlocks.GlossaryDocument.LastBuildingBlock
//ExFor:BuildingBlocks.BuildingBlockCollection
//ExFor:BuildingBlocks.BuildingBlockCollection.Item(System.Int32)
//ExFor:BuildingBlocks.BuildingBlockCollection.ToArray
//ExFor:BuildingBlocks.BuildingBlockGallery
//ExFor:GlossaryDocument
//ExFor:GlossaryDocument.Accept(DocumentVisitor)
//ExFor:GlossaryDocument.BuildingBlocks
//ExFor:GlossaryDocument.FirstBuildingBlock
//ExFor:GlossaryDocument.GetBuildingBlock(BuildingBlockGallery,String,String)
//ExFor:GlossaryDocument.LastBuildingBlock
//ExFor:BuildingBlockCollection
//ExFor:BuildingBlockCollection.Item(Int32)
//ExFor:BuildingBlockCollection.ToArray
//ExFor:BuildingBlockGallery
//ExFor:DocumentVisitor.VisitBuildingBlockEnd(BuildingBlock)
//ExFor:DocumentVisitor.VisitBuildingBlockStart(BuildingBlock)
//ExFor:DocumentVisitor.VisitGlossaryDocumentEnd(GlossaryDocument)
Expand Down
27 changes: 13 additions & 14 deletions Examples/ApiExamples/ApiExamples/ExCharts.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
// "as is", without warranty of any kind, either expressed or implied.
//////////////////////////////////////////////////////////////////////////

using Aspose;
using Aspose.Words;
using Aspose.Words.Drawing;
using Aspose.Words.Drawing.Charts;
Expand Down Expand Up @@ -127,8 +126,8 @@ public void AxisProperties()
//ExFor:AxisTickLabels.Position
//ExFor:AxisTickLabels.IsAutoSpacing
//ExFor:ChartAxis.TickMarkSpacing
//ExFor:Charts.AxisCategoryType
//ExFor:Charts.AxisCrosses
//ExFor:AxisCategoryType
//ExFor:AxisCrosses
//ExFor:Chart.AxisX
//ExFor:Chart.AxisY
//ExFor:Chart.AxisZ
Expand Down Expand Up @@ -237,10 +236,10 @@ public void DateTimeValues()
//ExFor:AxisScaling.Minimum
//ExFor:AxisScaling.Maximum
//ExFor:ChartAxis.Scaling
//ExFor:Charts.AxisTickMark
//ExFor:Charts.AxisTickLabelPosition
//ExFor:Charts.AxisTimeUnit
//ExFor:Charts.ChartAxis.BaseTimeUnit
//ExFor:AxisTickMark
//ExFor:AxisTickLabelPosition
//ExFor:AxisTimeUnit
//ExFor:ChartAxis.BaseTimeUnit
//ExFor:ChartAxis.HasMajorGridlines
//ExFor:ChartAxis.HasMinorGridlines
//ExSummary:Shows how to insert chart with date/time values.
Expand Down Expand Up @@ -353,9 +352,9 @@ public void SetNumberFormatToChartAxis()
{
//ExStart
//ExFor:ChartAxis.NumberFormat
//ExFor:Charts.ChartNumberFormat
//ExFor:ChartNumberFormat
//ExFor:ChartNumberFormat.FormatCode
//ExFor:Charts.ChartNumberFormat.IsLinkedToSource
//ExFor:ChartNumberFormat.IsLinkedToSource
//ExSummary:Shows how to set formatting for chart values.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Expand Down Expand Up @@ -626,7 +625,7 @@ private static void ApplyDataLabels(ChartSeries series, int labelsCount, string
//ExFor:ChartDataPointCollection.ClearFormat
//ExFor:ChartDataPointCollection.Count
//ExFor:ChartDataPointCollection.GetEnumerator
//ExFor:ChartDataPointCollection.Item(System.Int32)
//ExFor:ChartDataPointCollection.Item(Int32)
//ExFor:ChartMarker
//ExFor:ChartMarker.Size
//ExFor:ChartMarker.Symbol
Expand Down Expand Up @@ -694,7 +693,7 @@ private static void ApplyDataPoints(ChartSeries series, int dataPointsCount, Mar
public void PieChartExplosion()
{
//ExStart
//ExFor:Charts.IChartDataPoint.Explosion
//ExFor:IChartDataPoint.Explosion
//ExSummary:Shows how to move the slices of a pie chart away from the center.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Expand Down Expand Up @@ -729,9 +728,9 @@ public void PieChartExplosion()
public void Bubble3D()
{
//ExStart
//ExFor:Charts.ChartDataLabel.ShowBubbleSize
//ExFor:Charts.ChartDataLabel.Font
//ExFor:Charts.IChartDataPoint.Bubble3D
//ExFor:ChartDataLabel.ShowBubbleSize
//ExFor:ChartDataLabel.Font
//ExFor:IChartDataPoint.Bubble3D
//ExSummary:Shows how to use 3D effects with bubble charts.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Expand Down
2 changes: 1 addition & 1 deletion Examples/ApiExamples/ApiExamples/ExChmLoadOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public void OriginalFileName()

Document doc = new Document(new MemoryStream(File.ReadAllBytes(MyDir + "Document with ms-its links.chm")),
loadOptions);

doc.Save(ArtifactsDir + "ExChmLoadOptions.OriginalFileName.html");
//ExEnd
}
Expand Down
12 changes: 6 additions & 6 deletions Examples/ApiExamples/ApiExamples/ExDocument.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1630,7 +1630,7 @@ public void UpdateThumbnail()

// 2 - Use the first image found in the document:
ThumbnailGeneratingOptions options = new ThumbnailGeneratingOptions();
Assert.AreEqual(new Size(600, 900), options.ThumbnailSize); //ExSKip
Assert.AreEqual(new Size(600, 900), options.ThumbnailSize); //ExSkip
Assert.True(options.GenerateFromFirstPage); //ExSkip
options.ThumbnailSize = new Size(400, 400);
options.GenerateFromFirstPage = false;
Expand Down Expand Up @@ -1715,7 +1715,7 @@ public void OoxmlComplianceVersion()
public void ImageSaveOptions()
{
//ExStart
//ExFor:Document.Save(String, Saving.SaveOptions)
//ExFor:Document.Save(String, SaveOptions)
//ExFor:SaveOptions.UseAntiAliasing
//ExFor:SaveOptions.UseHighQualityRendering
//ExSummary:Shows how to improve the quality of a rendered document with SaveOptions.
Expand Down Expand Up @@ -1939,7 +1939,7 @@ public void LayoutOptionsHiddenText(bool showHiddenText)
//ExStart
//ExFor:Document.LayoutOptions
//ExFor:LayoutOptions
//ExFor:Layout.LayoutOptions.ShowHiddenText
//ExFor:LayoutOptions.ShowHiddenText
//ExSummary:Shows how to hide text in a rendered output document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Expand Down Expand Up @@ -1978,7 +1978,7 @@ public void LayoutOptionsParagraphMarks(bool showParagraphMarks)
//ExStart
//ExFor:Document.LayoutOptions
//ExFor:LayoutOptions
//ExFor:Layout.LayoutOptions.ShowParagraphMarks
//ExFor:LayoutOptions.ShowParagraphMarks
//ExSummary:Shows how to show paragraph marks in a rendered output document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Expand Down Expand Up @@ -2359,8 +2359,8 @@ public void ReadMacrosFromExistingDocument()
//ExFor:Document.VbaProject
//ExFor:VbaModuleCollection
//ExFor:VbaModuleCollection.Count
//ExFor:VbaModuleCollection.Item(System.Int32)
//ExFor:VbaModuleCollection.Item(System.String)
//ExFor:VbaModuleCollection.Item(Int32)
//ExFor:VbaModuleCollection.Item(String)
//ExFor:VbaModuleCollection.Remove
//ExFor:VbaModule
//ExFor:VbaModule.Name
Expand Down
2 changes: 1 addition & 1 deletion Examples/ApiExamples/ApiExamples/ExDocumentBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ public void ImportNode()
public void ImportNodeCustom()
{
//ExStart
//ExFor:DocumentBase.ImportNode(Node, System.Boolean, ImportFormatMode)
//ExFor:DocumentBase.ImportNode(Node, Boolean, ImportFormatMode)
//ExSummary:Shows how to import node from source document to destination document with specific options.
// Create two documents and add a character style to each document.
// Configure the styles to have the same name, but different text formatting.
Expand Down
2 changes: 1 addition & 1 deletion Examples/ApiExamples/ApiExamples/ExDocumentBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1119,7 +1119,7 @@ public void InsertCellsWithPreferredWidths()
//ExFor:PreferredWidth
//ExFor:PreferredWidth.Auto
//ExFor:PreferredWidth.Equals(PreferredWidth)
//ExFor:PreferredWidth.Equals(System.Object)
//ExFor:PreferredWidth.Equals(Object)
//ExFor:PreferredWidth.FromPoints
//ExFor:PreferredWidth.FromPercent
//ExFor:PreferredWidth.GetHashCode
Expand Down
22 changes: 11 additions & 11 deletions Examples/ApiExamples/ApiExamples/ExDocumentProperties.cs
Original file line number Diff line number Diff line change
Expand Up @@ -424,8 +424,8 @@ public void HyperlinkBase()
public void HeadingPairs()
{
//ExStart
//ExFor:Properties.BuiltInDocumentProperties.HeadingPairs
//ExFor:Properties.BuiltInDocumentProperties.TitlesOfParts
//ExFor:BuiltInDocumentProperties.HeadingPairs
//ExFor:BuiltInDocumentProperties.TitlesOfParts
//ExSummary:Shows the relationship between "HeadingPairs" and "TitlesOfParts" properties.
Document doc = new Document(MyDir + "Heading pairs and titles of parts.docx");

Expand Down Expand Up @@ -477,8 +477,8 @@ public void HeadingPairs()
public void Security()
{
//ExStart
//ExFor:Properties.BuiltInDocumentProperties.Security
//ExFor:Properties.DocumentSecurity
//ExFor:BuiltInDocumentProperties.Security
//ExFor:DocumentSecurity
//ExSummary:Shows how to use document properties to display the security level of a document.
Document doc = new Document();

Expand Down Expand Up @@ -583,13 +583,13 @@ public void DocumentPropertyCollection()
//ExFor:CustomDocumentProperties.Add(String,DateTime)
//ExFor:CustomDocumentProperties.Add(String,Double)
//ExFor:DocumentProperty.Type
//ExFor:Properties.DocumentPropertyCollection
//ExFor:Properties.DocumentPropertyCollection.Clear
//ExFor:Properties.DocumentPropertyCollection.Contains(System.String)
//ExFor:Properties.DocumentPropertyCollection.GetEnumerator
//ExFor:Properties.DocumentPropertyCollection.IndexOf(System.String)
//ExFor:Properties.DocumentPropertyCollection.RemoveAt(System.Int32)
//ExFor:Properties.DocumentPropertyCollection.Remove
//ExFor:DocumentPropertyCollection
//ExFor:DocumentPropertyCollection.Clear
//ExFor:DocumentPropertyCollection.Contains(String)
//ExFor:DocumentPropertyCollection.GetEnumerator
//ExFor:DocumentPropertyCollection.IndexOf(String)
//ExFor:DocumentPropertyCollection.RemoveAt(Int32)
//ExFor:DocumentPropertyCollection.Remove
//ExFor:PropertyType
//ExSummary:Shows how to work with a document's custom properties.
Document doc = new Document();
Expand Down
30 changes: 15 additions & 15 deletions Examples/ApiExamples/ApiExamples/ExDocumentVisitor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -219,12 +219,12 @@ private static void TestDocStructureToText(DocStructurePrinter visitor)
//ExFor:Cell.Accept(DocumentVisitor)
//ExFor:Cell.IsFirstCell
//ExFor:Cell.IsLastCell
//ExFor:DocumentVisitor.VisitTableEnd(Tables.Table)
//ExFor:DocumentVisitor.VisitTableStart(Tables.Table)
//ExFor:DocumentVisitor.VisitRowEnd(Tables.Row)
//ExFor:DocumentVisitor.VisitRowStart(Tables.Row)
//ExFor:DocumentVisitor.VisitCellStart(Tables.Cell)
//ExFor:DocumentVisitor.VisitCellEnd(Tables.Cell)
//ExFor:DocumentVisitor.VisitTableEnd(Table)
//ExFor:DocumentVisitor.VisitTableStart(Table)
//ExFor:DocumentVisitor.VisitRowEnd(Row)
//ExFor:DocumentVisitor.VisitRowStart(Row)
//ExFor:DocumentVisitor.VisitCellStart(Cell)
//ExFor:DocumentVisitor.VisitCellEnd(Cell)
//ExFor:Row.Accept(DocumentVisitor)
//ExFor:Row.FirstCell
//ExFor:Row.GetText
Expand Down Expand Up @@ -955,11 +955,11 @@ private static void TestFootnoteToText(FootnoteStructurePrinter visitor)
}

//ExStart
//ExFor:DocumentVisitor.VisitOfficeMathEnd(Math.OfficeMath)
//ExFor:DocumentVisitor.VisitOfficeMathStart(Math.OfficeMath)
//ExFor:Math.MathObjectType
//ExFor:Math.OfficeMath.Accept(DocumentVisitor)
//ExFor:Math.OfficeMath.MathObjectType
//ExFor:DocumentVisitor.VisitOfficeMathEnd(OfficeMath)
//ExFor:DocumentVisitor.VisitOfficeMathStart(OfficeMath)
//ExFor:MathObjectType
//ExFor:OfficeMath.Accept(DocumentVisitor)
//ExFor:OfficeMath.MathObjectType
//ExSummary:Shows how to print the node structure of every office math node in a document.
[Test] //ExSkip
public void OfficeMathToText()
Expand Down Expand Up @@ -1064,8 +1064,8 @@ private static void TestOfficeMathToText(OfficeMathStructurePrinter visitor)
}

//ExStart
//ExFor:DocumentVisitor.VisitSmartTagEnd(Markup.SmartTag)
//ExFor:DocumentVisitor.VisitSmartTagStart(Markup.SmartTag)
//ExFor:DocumentVisitor.VisitSmartTagEnd(SmartTag)
//ExFor:DocumentVisitor.VisitSmartTagStart(SmartTag)
//ExSummary:Shows how to print the node structure of every smart tag in a document.
[Test] //ExSkip
public void SmartTagToText()
Expand Down Expand Up @@ -1171,8 +1171,8 @@ private static void TestSmartTagToText(SmartTagStructurePrinter visitor)

//ExStart
//ExFor:StructuredDocumentTag.Accept(DocumentVisitor)
//ExFor:DocumentVisitor.VisitStructuredDocumentTagEnd(Markup.StructuredDocumentTag)
//ExFor:DocumentVisitor.VisitStructuredDocumentTagStart(Markup.StructuredDocumentTag)
//ExFor:DocumentVisitor.VisitStructuredDocumentTagEnd(StructuredDocumentTag)
//ExFor:DocumentVisitor.VisitStructuredDocumentTagStart(StructuredDocumentTag)
//ExSummary:Shows how to print the node structure of every structured document tag in a document.
[Test] //ExSkip
public void StructuredDocumentTagToText()
Expand Down
Loading

0 comments on commit 195d66e

Please sign in to comment.