Skip to content

Commit

Permalink
update api doc (#217)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.sdl.com>
  • Loading branch information
icmoldovan and github-actions[bot] authored May 24, 2024
1 parent 8990012 commit c36a006
Show file tree
Hide file tree
Showing 11 changed files with 157 additions and 157 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ items:
assemblies:
- Sdl.FileTypeSupport.Framework.Core
namespace: Sdl.FileTypeSupport.Framework.BilingualApi
summary: "\nAdvances to the next possible location. This will move to\nthe next available position according to the following priority list:\n<ul><li></li><li></li><li></li></ul>\nIf no such location is available (i.e. the location is currently behind the last item in the top level), \nthe location is not changed, and the method returns false.\n\nIf the location is invalid, the behavior is undefined and exceptions may be thrown.\n"
summary: "\nAdvances to the next possible location. This will move to\nthe next available position according to the following priority list:\n<ul><li>First child</li><li>Next Sibling</li><li>Next Parent Sibling</li></ul>\nIf no such location is available (i.e. the location is currently behind the last item in the top level), \nthe location is not changed, and the method returns false.\n\nIf the location is invalid, the behavior is undefined and exceptions may be thrown.\n"
syntax:
content: public bool MoveNext()
return:
Expand Down Expand Up @@ -267,7 +267,7 @@ items:
assemblies:
- Sdl.FileTypeSupport.Framework.Core
namespace: Sdl.FileTypeSupport.Framework.BilingualApi
summary: "\nMoves the location to the preceding available position according to the following priority list:\n<ul><li></li><li></li><li></li></ul>\nIf no parent is available (i.e. location is before the first item in the top level), the location\nis not changed, and the method returns false.\n"
summary: "\nMoves the location to the preceding available position according to the following priority list:\n<ul><li>Previous Sibling Last Child</li><li>Previous Sibling</li><li>Parent</li></ul>\nIf no parent is available (i.e. location is before the first item in the top level), the location\nis not changed, and the method returns false.\n"
syntax:
content: public bool MovePrevious()
return:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ items:
summary: "\nConvenient implementation class for settings pages that handles the initialization of settings\nand controls, and provides a default implementation of the file type specific settings page interface.\n"
remarks: "\n<p>\nSettings pages do not need to be derived from this class. However, if they follow standard patterns, deriving from this class\ncan result in a simpler implementation.\n</p>\n"
example:
- "\n<p>\nTo use this class in order to implement a file type settings page, take the following steps:\n</p>\n<ul><li></li><li></li><li></li></ul>\n<p>\nThe default implementation of the settings page and the data binding will take care of everything else. Unless you\nrequire special processing for anything, there should be no need to override any of the methods and properties\nin this base class.\n</p>\n"
- "\n<p>\nTo use this class in order to implement a file type settings page, take the following steps:\n</p>\n<ul><li>Create a settings class that implements <xref href=\"Sdl.FileTypeSupport.Framework.Core.Settings.FileTypeSettingsBase\" data-throw-if-not-resolved=\"false\"></xref>. Make sure that your property setters\nare raising the <xref href=\"System.ComponentModel.INotifyPropertyChanged.PropertyChanged\" data-throw-if-not-resolved=\"false\"></xref> event when values change. Implement the\n<xref href=\"Sdl.FileTypeSupport.Framework.Core.Settings.FileTypeSettingsBase.ResetToDefaults\" data-throw-if-not-resolved=\"false\"></xref> method by calling the property setters (rather than updating\nthe fields directly). Implement settings reading and writing functionality using the settings bundle.</li><li>\nCreate a settings control for the settings page, and implement <code>IFileTypeSettingsAware</code> for your settings class. \nIn the property setter for Settings, assign the value to <code>LayoutRoot.DataContext</code>. \nImplement the user interface by using two-way data binding to access and update the settings.\n</li><li>\nCreate a settings page class derived from this class and mark it with the <xref href=\"Sdl.FileTypeSupport.Framework.Core.Settings.FileTypeSettingsPageAttribute\" data-throw-if-not-resolved=\"false\"></xref>.\n</li></ul>\n<p>\nThe default implementation of the settings page and the data binding will take care of everything else. Unless you\nrequire special processing for anything, there should be no need to override any of the methods and properties\nin this base class.\n</p>\n"
syntax:
content: >-
public abstract class AbstractFileTypeSettingsPage<SettingsControlType, SettingsType> : AbstractSettingsPage, IFileTypeConfigurationAware where SettingsControlType : new()
Expand Down
Loading

0 comments on commit c36a006

Please sign in to comment.