yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adds/Fixes xdoc comments

Browse Source
This commit is contained in:
Elitsa Marinovska
2022-03-16 10:30:02 +01:00
parent 92480b8446
commit cf9f4f39e4
2 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/Umbraco.Infrastructure/Templates/HtmlMacroParameterParser.cs
View File

@@ -28,7 +28,7 @@ namespace Umbraco.Cms.Infrastructure.Templates
/// <summary>
/// Parses out media UDIs from an HTML string based on embedded macro parameter values.
/// </summary>
/// <param name="text"></param>
/// <param name="text">HTML string</param>
/// <returns></returns>
public IEnumerable<UmbracoEntityReference> FindUmbracoEntityReferencesFromEmbeddedMacros(string text)
{
@@ -45,7 +45,7 @@ namespace Umbraco.Cms.Infrastructure.Templates
}
/// <summary>
/// Parses out media UDIs from Macro Grid Control Parameters.
/// Parses out media UDIs from Macro Grid Control parameters.
/// </summary>
/// <param name="macroGridControls"></param>
/// <returns></returns>

16
src/Umbraco.Infrastructure/Templates/IHtmlMacroParameterParser.cs
View File

@@ -4,10 +4,24 @@ using Umbraco.Cms.Core.Models.Editors;
namespace Umbraco.Cms.Infrastructure.Templates
{
/// <summary>
/// Provides methods to parse referenced entities as Macro parameters.
/// </summary>
public interface IHtmlMacroParameterParser
{
/// <summary>
/// Parses out media UDIs from an HTML string based on embedded macro parameter values.
/// </summary>
/// <param name="text">HTML string</param>
/// <returns></returns>
IEnumerable<UmbracoEntityReference> FindUmbracoEntityReferencesFromEmbeddedMacros(string text);
IEnumerable<UmbracoEntityReference> FindUmbracoEntityReferencesFromGridControlMacros(IEnumerable<GridValue.GridControl> macroValues);
/// <summary>
/// Parses out media UDIs from Macro Grid Control parameters.
/// </summary>
/// <param name="macroGridControls"></param>
/// <returns></returns>
IEnumerable<UmbracoEntityReference> FindUmbracoEntityReferencesFromGridControlMacros(IEnumerable<GridValue.GridControl> macroGridControls);
}
}