Commit 6f60be42 authored by Nuno Alves's avatar Nuno Alves
Browse files

complete annotation is some methods

parent b20408a8
Pipeline #386878 passed with stage
in 15 seconds
......@@ -42,7 +42,7 @@ namespace PDFGenerator.EvaluationReport
/// <summary>
/// Gets the current page.
/// </summary>
/// <returns></returns>
/// <returns>the current page</returns>
protected int GetCurrentPage()
{
return Document.GetPdfDocument().GetNumberOfPages();
......@@ -51,7 +51,7 @@ namespace PDFGenerator.EvaluationReport
/// <summary>
/// Gets default page size.
/// </summary>
/// <returns></returns>
/// <returns>the default page size</returns>
protected PageSize GetPageSize()
{
return Document.GetPdfDocument().GetDefaultPageSize();
......@@ -173,7 +173,7 @@ namespace PDFGenerator.EvaluationReport
/// <summary>
/// Changes the page orientation.
/// </summary>
/// <param name="orientation"></param>
/// <param name="orientation">orientation that the page should assume</param>
protected void SetPageOrientation(Orientation orientation)
{
if (orientation == Orientation.Landscape)
......@@ -215,7 +215,7 @@ namespace PDFGenerator.EvaluationReport
/// <summary>
/// Adds scaled image to document.
/// </summary>
/// <param name="image"></param>
/// <param name="image">image to be scaled</param>
private void AddScaledImage(Image image)
{
Document.Add(GetScaledImage(image));
......
......@@ -34,7 +34,7 @@ namespace PDFGenerator.EvaluationReport
/// <summary>
/// Adds pillar information to document and goes through all its quality targets.
/// </summary>
/// <param name="pillar"></param>
/// <param name="pillar">input pillar</param>
private void RenderPillar(Pillar pillar)
{
Bookmarks.AddRootOutline(pillar.Heading, RootOutline);
......@@ -56,7 +56,7 @@ namespace PDFGenerator.EvaluationReport
/// <summary>
/// Adds quality target information to document and goes through all its criteria.
/// </summary>
/// <param name="qualityTarget"></param>
/// <param name="qualityTarget">input quality target</param>
private void RenderQualityTarget(QualityTarget qualityTarget)
{
string section = qualityTarget.Paragraphs[0];
......@@ -90,7 +90,7 @@ namespace PDFGenerator.EvaluationReport
/// <summary>
/// Adds criterion information to document and goes through all its kpi evaluations.
/// </summary>
/// <param name="criterion"></param>
/// <param name="criterion">input criterion</param>
private void RenderCriterion(Criterion criterion)
{
new CriterionTarget(criterion.CriterionTarget, Results.Sections[criterion.CriterionTarget.Paragraphs[0]], CustomUploads,
......
......@@ -33,7 +33,7 @@ namespace PDFGenerator.EvaluationReport
/// <summary>
/// Adds a new item to the list.
/// </summary>
/// <param name="item"></param>
/// <param name="item">new item to be added</param>
public void AddToTOC(TocItem item)
{
TocItems.Add(item);
......@@ -42,7 +42,7 @@ namespace PDFGenerator.EvaluationReport
/// <summary>
/// Renders the content for the table of contents.
/// </summary>
/// <param name="appendixStart"></param>
/// <param name="appendixStart">the appendix start page number</param>
public void Render(int appendixStart)
{
TocPages = NumerOfPagesForTOC(appendixStart);
......@@ -53,7 +53,7 @@ namespace PDFGenerator.EvaluationReport
/// <summary>
/// Determines the number of pages for rendering the table of contents.
/// </summary>
/// <param name="appendixStart"> the page number for the appendix start</param>
/// <param name="appendixStart"> the appendix start page number</param>
/// <returns></returns>
private int NumerOfPagesForTOC(int appendixStart)
{
......@@ -84,7 +84,7 @@ namespace PDFGenerator.EvaluationReport
/// Adds the table of contents content to the document.
/// </summary>
/// <param name="document">the PDF document</param>
/// <param name="appendixStart">the page number for the appendix start</param>
/// <param name="appendixStart">the appendix start page number</param>
private void AddTOC(Document document, int appendixStart)
{
Paragraph paragraph = new Paragraph(new Text("Inhaltsverzeichnis").AddStyle(Styles.H1)).SetMarginBottom(20f);
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment