Skip to content

Add support enum links #188

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

Merged
Girgias merged 5 commits into from
Feb 6, 2025
Merged

Add support enum links #188

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
71feff8
add support enum links
SakiTakamachi Jan 29, 2025
af50d4e
address a comment
SakiTakamachi Jan 30, 2025
b31954b
Add a test
SakiTakamachi Jan 31, 2025
a3d7cd0
Supports enum links in type tags
SakiTakamachi Jan 31, 2025
9920765
typo
SakiTakamachi Jan 31, 2025
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
Prev Previous commit
Next Next commit
Add a test
  • Loading branch information
@SakiTakamachi
SakiTakamachi committed Jan 31, 2025
commit b31954b5a57e979ea2284863af1c1122e5daa7cb
26 changes: 26 additions & 0 deletions tests/package/php/data/enum_link_rendering.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xml:id="enum_link_rendering" xmlns="http://docbook.org/ns/docbook">

<section>
<para>1. Existing Enum linking</para>
<enumname>Enum\Namespace\Existing_Enum</enumname>
<enumname>\Enum\Namespace\Existing_Enum</enumname>
</section>

<section>
<para>2. Enum linking (non-FQN) in method/function parameter and return type</para>
<methodsynopsis>
<type>Enum\Namespace\Existing_Enum</type><methodname>method_name</methodname>
<methodparam><type>Enum\Namespace\Existing_Enum</type><parameter>paramName</parameter></methodparam>
</methodsynopsis>
</section>

<section>
<para>3. Enum linking (FQN) in method/function parameter and return type</para>
<methodsynopsis>
<type>\Enum\Namespace\Existing_Enum</type><methodname>method_name</methodname>
<methodparam><type>\Enum\Namespace\Existing_Enum</type><parameter>paramName</parameter></methodparam>
</methodsynopsis>
</section>

</chapter>
54 changes: 54 additions & 0 deletions tests/package/php/enum_link_rendering.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
--TEST--
Enum link rendering
--FILE--
<?php
namespace phpdotnet\phd;

require_once __DIR__ . "/../../setup.php";

$config->xmlFile = __DIR__ . "/data/enum_link_rendering.xml";

$format = new TestPHPChunkedXHTML($config, $outputHandler);
$format->SQLiteIndex(
null, // $context,
null, // $index,
"enum.enum-namespace-existing-enum", // $id,
"enumname.enumpage", // $filename,
"", // $parent,
"", // $sdesc,
"", // $ldesc,
"phpdoc:classref", // $element,
"", // $previous,
"", // $next,
0, // $chunk
);

$format->addClassname("enum.enum-namespace-existing-enum", "enum\\namespace\\existing_enum");

$render = new TestRender(new Reader($outputHandler), $config, $format);
$render->run();
?>
--EXPECT--
Filename: enum_link_rendering.html
Content:
<div id="enum_link_rendering" class="chapter">

<div class="section">
<p class="para">1. Existing Enum linking</p>
<span class="enumname"><a href="enum.enum-namespace-existing-enum.html" class="enumname">Enum\Namespace\Existing_Enum</a></span>
<span class="enumname"><a href="enum.enum-namespace-existing-enum.html" class="enumname">\Enum\Namespace\Existing_Enum</a></span>
</div>

<div class="section">
<p class="para">2. Enum linking (non-FQN) in method/function parameter and return type</p>
<div class="methodsynopsis dc-description"><span class="methodname"><strong>method_name</strong></span>(<span class="methodparam"><span class="type"><a href="enumname.enumpage.html" class="type Enum\Namespace\Existing_Enum">Enum\Namespace\Existing_Enum</a></span> <code class="parameter">$paramName</code></span>): <span class="type"><a href="enumname.enumpage.html" class="type Enum\Namespace\Existing_Enum">Enum\Namespace\Existing_Enum</a></span></div>

</div>

<div class="section">
<p class="para">3. Enum linking (FQN) in method/function parameter and return type</p>
<div class="methodsynopsis dc-description"><span class="methodname"><strong>method_name</strong></span>(<span class="methodparam"><span class="type"><a href="enumname.enumpage.html" class="type Enum\Namespace\Existing_Enum">\Enum\Namespace\Existing_Enum</a></span> <code class="parameter">$paramName</code></span>): <span class="type"><a href="enumname.enumpage.html" class="type Enum\Namespace\Existing_Enum">\Enum\Namespace\Existing_Enum</a></span></div>

</div>

</div>