Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/2389 show reference docs for specific method class #3941

Merged
merged 9 commits into from
Aug 30, 2022
Merged

Feature/2389 show reference docs for specific method class #3941

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4b9f381
proof-of-concept implementation for show/hide documentation
Vailorium Aug 10, 2022
3248e8c
added isComment attribute to codeline, show documentation checkbox no…
Vailorium Aug 15, 2022
66bb87a
adjust name of comment line variable
Vailorium Aug 15, 2022
10d6ec4
fixed documentation folding, show documentation now toggles without r…
Vailorium Aug 16, 2022
3386209
added more efficient show/hide all documentation
Vailorium Aug 19, 2022
aac6051
removed unreachable code, removed unused comment icon
Vailorium Aug 19, 2022
6428ba4
solve merge conflicts merge main into feature/2389
Vailorium Aug 19, 2022
fbb93d1
return rendered arrays cache to renderedcodefile
Vailorium Aug 29, 2022
f7736fc
code style fixes
Vailorium Aug 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions src/dotnet/APIView/APIView/CodeFileRenderer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ public class CodeFileRenderer
{
public static CodeFileRenderer Instance = new CodeFileRenderer();

public CodeLine[] Render(CodeFile file, bool showDocumentation = false, bool enableSkipDiff = false)
public CodeLine[] Render(CodeFile file, bool enableSkipDiff = false)
{
var list = new List<CodeLine>();
Render(list, file.Tokens, showDocumentation, enableSkipDiff);
Render(list, file.Tokens, enableSkipDiff);
return list.ToArray();
}

private void Render(List<CodeLine> list, IEnumerable<CodeFileToken> node, bool showDocumentation, bool enableSkipDiff)
private void Render(List<CodeLine> list, IEnumerable<CodeFileToken> node, bool enableSkipDiff)
{
var stringBuilder = new StringBuilder();
string currentId = null;
Expand All @@ -39,9 +39,6 @@ private void Render(List<CodeLine> list, IEnumerable<CodeFileToken> node, bool s
if (enableSkipDiff && isSkipDiffRange && token.Kind != CodeFileTokenKind.SkipDiffRangeEnd)
continue;

if (!showDocumentation && isDocumentationRange && token.Kind != CodeFileTokenKind.DocumentRangeEnd)
continue;

switch(token.Kind)
{
case CodeFileTokenKind.Newline:
Expand All @@ -68,7 +65,7 @@ private void Render(List<CodeLine> list, IEnumerable<CodeFileToken> node, bool s
lineClass = lineClass.Trim();
}

list.Add(new CodeLine(stringBuilder.ToString(), currentId, lineClass, indentSize));
list.Add(new CodeLine(stringBuilder.ToString(), currentId, lineClass, indentSize, isDocumentationRange));
currentId = null;
stringBuilder.Clear();
break;
Expand Down
4 changes: 3 additions & 1 deletion src/dotnet/APIView/APIView/CodeLine.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,15 @@ namespace ApiView
public string ElementId { get; }
public string LineClass { get; }
public int IndentSize { get; }
public bool IsDocumentation { get; }

public CodeLine(string html, string id, string lineClass, int indentSize = 0)
public CodeLine(string html, string id, string lineClass, int indentSize = 0, bool isDocumentation = false)
{
this.DisplayString = html;
this.ElementId = id;
this.LineClass = lineClass;
this.IndentSize = indentSize;
this.IsDocumentation = isDocumentation;
}

public override string ToString()
Expand Down
30 changes: 29 additions & 1 deletion src/dotnet/APIView/APIViewWeb/Client/css/site.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -772,6 +772,14 @@ code {
z-index: 1;
}

.icon-chevron-right {
background: url(/icons/chevron-right.svg) center center no-repeat;
}

.icon-chevron-up {
background: url(/icons/chevron-up.svg) center center no-repeat;
}

.icon-language {
width: 34px;
height: 34px;
Expand Down Expand Up @@ -828,7 +836,6 @@ code {
.icon-swagger {
background: url(/icons/swagger-original.svg) center center no-repeat;
}

/*---------------------------------------------------------------------*/

.info-text {
Expand Down Expand Up @@ -875,6 +882,27 @@ code {
left: 0px;
}

.line-toggle-documentation-button:hover {
transform: scale(1);
}

.line-toggle-documentation-button {
display: inline-block;
width: 21px;
height: 21px;
line-height: 21px;
color: #fff !important;
text-align: center;
text-indent: 0;
cursor: pointer;
background-color: #0366d6;
border-radius: 3px;
box-shadow: 0 1px 4px rgba(27, 31, 35, .15);
transition: transform .1s ease-in-out;
transform: scale(.8);
user-select: none;
}

.line-details-button-cell {
width: 22px;
height: 22px;
Expand Down
36 changes: 34 additions & 2 deletions src/dotnet/APIView/APIViewWeb/Client/src/review.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ import { updatePageSettings } from "./helpers";
$(() => {
const SEL_DOC_CLASS = ".documentation";
const SHOW_DOC_CHECK_COMPONENT = "#show-documentation-component";
const SHOW_DOC_CHECKBOX = ".show-doc-checkbox";
const SHOW_DOC_CHECKBOX = "#show-doc-checkbox";
const SHOW_DOC_HREF = ".show-document";
const SHOW_DIFFONLY_CHECKBOX = ".show-diffonly-checkbox";
const SHOW_DIFFONLY_HREF = ".show-diffonly";
const TOGGLE_DOCUMENTATION = ".line-toggle-documentation-button";

hideCheckboxIfNoDocs();

Expand Down Expand Up @@ -63,7 +64,21 @@ $(() => {
/* TOGGLE PAGE OPTIONS
--------------------------------------------------------------------------------------------------------------------------------------------------------*/
$(SHOW_DOC_CHECKBOX).on("click", e => {
$(SHOW_DOC_HREF)[0].click();
if((e.target as HTMLInputElement).checked) {
// show all documentation
$(".code-line-documentation").removeClass('hidden-row');
$(TOGGLE_DOCUMENTATION).removeClass("icon-chevron-right");
$(TOGGLE_DOCUMENTATION).addClass("icon-chevron-up");
} else {
// hide all documentation
$(".code-line-documentation").addClass("hidden-row");
$(TOGGLE_DOCUMENTATION).removeClass("icon-chevron-up");
$(TOGGLE_DOCUMENTATION).addClass("icon-chevron-right");
}
});

$(SHOW_DOC_HREF).on("click", e => {
$(SHOW_DOC_CHECKBOX)[0].click();
});

$(SHOW_DIFFONLY_CHECKBOX).on("click", e => {
Expand Down Expand Up @@ -98,6 +113,23 @@ $(() => {
});
});

/* TOGGLE DOCUMENTATION DROPDOWN
--------------------------------------------------------------------------------------------------------------------------------------------------------*/
$(TOGGLE_DOCUMENTATION).on("click", function(e){
const documentedBy = $(this).data('documented-by');
const codeLines = $(".code-window > tbody > .code-line");

for(var i = 0; i < documentedBy.length; i++) {
$(codeLines[documentedBy[i] - 1]).toggleClass("hidden-row");
}

$(this).toggleClass('icon-chevron-right');
$(this).toggleClass('icon-chevron-up');

// scroll button to center of screen, so that the line is visible after toggling folding
$(this).get(0).scrollIntoView({ block: "center"});
});

/* DROPDOWN FILTER FOR REVIEW, REVISIONS AND DIFF (UPDATES REVIEW PAGE ON CHANGE)
--------------------------------------------------------------------------------------------------------------------------------------------------------*/
$('#revisions-bootstraps-select, #review-bootstraps-select, #diff-bootstraps-select').each(function(index, value) {
Expand Down
4 changes: 3 additions & 1 deletion src/dotnet/APIView/APIViewWeb/Models/CodeLineModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,21 @@ namespace APIViewWeb.Models
{
public readonly struct CodeLineModel
{
public CodeLineModel(DiffLineKind kind, CodeLine codeLine, CommentThreadModel commentThread, CodeDiagnostic[] diagnostics, int lineNumber)
public CodeLineModel(DiffLineKind kind, CodeLine codeLine, CommentThreadModel commentThread, CodeDiagnostic[] diagnostics, int lineNumber, int[] documentedByLines)
{
CodeLine = codeLine;
CommentThread = commentThread;
Diagnostics = diagnostics;
Kind = kind;
LineNumber = lineNumber;
DocumentedByLines = documentedByLines;
}

public CodeLine CodeLine { get; }
public CodeDiagnostic[] Diagnostics { get; }
public CommentThreadModel CommentThread { get; }
public DiffLineKind Kind { get; }
public int LineNumber { get; }
public int[] DocumentedByLines { get; }
}
}
50 changes: 8 additions & 42 deletions src/dotnet/APIView/APIViewWeb/Models/RenderedCodeFile.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,61 +8,27 @@ namespace APIViewWeb.Models
{
public class RenderedCodeFile
{
private CodeLine[] _rendered;
private CodeLine[] _renderedReadOnly;
private CodeLine[] _renderedText;

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did we remove these rendered array?

public RenderedCodeFile(CodeFile codeFile)
{
CodeFile = codeFile;
}

public CodeFile CodeFile { get; }

public CodeLine[] Render(bool showDocumentation)
public CodeLine[] Render()
{
//Always render when documentation is requested to avoid cach thrashing
if (showDocumentation)
{
return CodeFileHtmlRenderer.Normal.Render(CodeFile, showDocumentation: true);
}

if (_rendered == null)
{
_rendered = CodeFileHtmlRenderer.Normal.Render(CodeFile);
}

return _rendered;
//Always render to avoid cach thrashing
return CodeFileHtmlRenderer.Normal.Render(CodeFile);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure why we can't cache it since we always return documentation. Cache rendered object helps on perf side when review revision is accessed so frequently.

}

public CodeLine[] RenderReadOnly(bool showDocumentation)
public CodeLine[] RenderReadOnly()
{
if (showDocumentation)
{
return CodeFileHtmlRenderer.ReadOnly.Render(CodeFile, showDocumentation: true);
}

if (_renderedReadOnly == null)
{
_renderedReadOnly = CodeFileHtmlRenderer.ReadOnly.Render(CodeFile);
}

return _renderedReadOnly;
return CodeFileHtmlRenderer.ReadOnly.Render(CodeFile);
}

internal CodeLine[] RenderText(bool showDocumentation, bool skipDiff = false)
internal CodeLine[] RenderText(bool skipDiff = false)
{
if (showDocumentation || skipDiff)
{
return CodeFileRenderer.Instance.Render(CodeFile, showDocumentation: showDocumentation, enableSkipDiff: skipDiff);
}

if (_renderedText == null)
{
_renderedText = CodeFileRenderer.Instance.Render(CodeFile);
}

return _renderedText;
return CodeFileRenderer.Instance.Render(CodeFile, enableSkipDiff: skipDiff);
}
}
}
}
12 changes: 4 additions & 8 deletions src/dotnet/APIView/APIViewWeb/Pages/Assemblies/Review.cshtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@
</label>
</span>
<span class="dropdown-item" id="show-documentation-component">
<input asp-for="@Model.ShowDocumentation" class="show-doc-checkbox">
<a class="text-dark show-document" asp-all-route-data=@Model.GetRoutingData(diffRevisionId: Model.DiffRevisionId, showDocumentation: !Model.ShowDocumentation, showDiffOnly: Model.ShowDiffOnly, revisionId: Model.Revision.RevisionId)>
<input type="checkbox" id="show-doc-checkbox">
<a class="text-dark show-document">
<label>&nbsp;Show Documentation</label>
</a>
</span>
Expand Down Expand Up @@ -146,7 +146,7 @@
{
<span class="dropdown-item">
<input asp-for="@Model.ShowDiffOnly" class="show-diffonly-checkbox">
<a class="text-dark show-diffonly" asp-all-route-data=@Model.GetRoutingData(diffRevisionId: Model.DiffRevisionId, showDocumentation: Model.ShowDocumentation, showDiffOnly: !Model.ShowDiffOnly, revisionId: Model.Revision.RevisionId)>
<a class="text-dark show-diffonly" asp-all-route-data=@Model.GetRoutingData(diffRevisionId: Model.DiffRevisionId, showDiffOnly: !Model.ShowDiffOnly, revisionId: Model.Revision.RevisionId)>
<label>&nbsp;Show Only Diff</label>
</a>
</span>
Expand Down Expand Up @@ -232,8 +232,7 @@
var optionName = revision.IsApproved ? $"{@revision.DisplayName} {@approvedBadge}" : @revision.DisplayName;
var urlValue = @Url.ActionLink("Review", "Assemblies", new {
id = @Model.Review.ReviewId,
revisionId = @revision.RevisionId,
doc = @Model.ShowDocumentation
revisionId = @revision.RevisionId
});
if (@revision.DisplayName == @Model.Revision.DisplayName)
{
Expand All @@ -256,7 +255,6 @@
id = @Model.Review.ReviewId,
revisionId = @Model.Revision.RevisionId,
diffRevisionId = @Model.DiffRevisionId,
doc = @Model.ShowDocumentation,
diffOnly = @Model.ShowDiffOnly
});
<label class="mb-0 ml-1"><a href="@urlValue"><small>Diff With:</small></a></label>
Expand All @@ -267,7 +265,6 @@
id = @Model.Review.ReviewId,
revisionId = @Model.Revision.RevisionId,
diffRevisionId = @Model.PreviousRevisions.Last().RevisionId,
doc = @Model.ShowDocumentation,
diffOnly = @Model.ShowDiffOnly
});
<label class="mb-0 ml-1"><a href="@urlValue"><small>Diff:</small></a></label>
Expand All @@ -284,7 +281,6 @@
var urlValue = @Url.ActionLink("Review", "Assemblies", new {
id = @Model.Review.ReviewId,
diffRevisionId = @revision.RevisionId,
doc = @Model.ShowDocumentation,
diffOnly = @Model.ShowDiffOnly,
revisionId = @Model.Revision.RevisionId
});
Expand Down
Loading