saggre / phpdocumentor-markdown Goto Github PK
View Code? Open in Web Editor NEWGenerate Markdown documentation from PHP code
License: MIT License
Generate Markdown documentation from PHP code
License: MIT License
Correct url:
https://github.com/Saggre/phpDocumentor-markdown/wiki/AbstractProduct
Generated url (0.1.3):
https://github.com/Saggre/phpDocumentor-markdown/wiki/classes/PhpDocumentorMarkdown/Example/AbstractProduct.md
Fix: Add GitLab and GitHub targets, which generate urls accordingly.
Interface implementations don't have a link to the implemented interface
When I tried to create documentation for this interface:
<?php
/**
* Файл с интерфейсом
* события для `Selsyn`
*
* PHP version 8
*
* @category Event
* @package Selsyn
* @author Whatis <[email protected]>
* @license unlicense
* @link https://github.com/TheWhatis/Selsyn
*/
namespace Whatis\Selsyn\Event;
use Psr\EventDispatcher\StoppableEventInterface;
/**
* Интерфейс для `Selsyn`
*
* PHP version 8
*
* @category Event
* @package Selsyn
* @author Whatis <[email protected]>
* @license unlicense
* @link https://github.com/TheWhatis/Selsyn
*/
interface IEvent extends StoppableEventInterface
{
/**
* Получить название события
*
* @return string
*/
public static function getName(): string;
}
I got an error: strtr(): Argument #1 ($string) must be of type string, phpDocumentor\Descriptor\Collection given
.
There was no time to wait until you read and correct (if you correct at all), so I myself found where the problem is.
I replaced this in the file interface.md.twig
:
{% if node.parent and node.parent is not empty %}* Parent interface: {{ macros.mdClassLink(node.parent, macros.mdClassPath(node), node.parent.FullyQualifiedStructuralElementName) }}
{% endif %}
For this:
{% if node.parent and node.parent is not empty %}
* Parent interfaces: {% for parent in node.parent %}{% if loop.index0 > 0 %}{{ ', ' }}{% endif %}{{ macros.mdClassLink(parent, macros.mdClassPath(node), parent.FullyQualifiedStructuralElementName) }}{% endfor %}
{% endif %}
I would be grateful if you correct)
Missing tests for most macros in themes/markdown/include/macros.twig
No automated testing with GitHub Actions
Suggestion: For internal links, remove the .md
appendix in order to provide compatibility with Wiki pages. Current template opens raw md files instead of rendering it.
Markdown files don't have a link back to home or to an upper level file
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.