Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.programming > #12498 > unrolled thread

[phpdoc] @uses and @usesby tags

Back to article view | Back to comp.programming

Contents

  [phpdoc] @uses and @usesby tags fictitious <a@b.invalid> - 2021-04-27 09:48 +0200
    Re: [phpdoc] @uses and @usesby tags Härra Ramob <hrramob@gmail.com> - 2022-01-05 00:24 -0800

#12498 — [phpdoc] @uses and @usesby tags

++ cat phpdoc.dist.xml
<?xml version="1.0" encoding="UTF-8" ?>
<phpdocumentor
         configVersion="3"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="https://www.phpdoc.org"

xsi:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd"
 >
     <paths>
         <output>build/api</output>
         <cache>build/cache</cache>
     </paths>
     <version number="3.0.0">
         <api>
             <source dsn=".">
                 <path>src</path>
             </source>
         </api>
     </version>
</phpdocumentor>
++ cat src/uses.php
<?php

class Client {
     /**
      * @uses Server::method2()
      */
     function method1(){}
}

class Server {
     function method2(){}
}
++ phpdoc # making documentation...
++ cd build/api/classes
++ firefox Client.html # OUTPUT: https://pasteboard.co/JZ5l756.png
++ firefox Server.html # OUTPUT: https://pasteboard.co/JZ5mB8t.png

If Server::method2() appears in the Tags -> uses section of Client 
documentation page (https://pasteboard.co/JZ5l756.png),
Client::method1() should appear in the Server documentation page 
(https://pasteboard.co/JZ5mB8t.png).
Why not compare?

Of course hoping to have understood what is written here
https://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.uses.pkg.html 


I also tried to post on more specific newsgroups (comp.lang.php, 
etc...), but no response :(

[toc] | [next] | [standalone]

#14412

fictitious kirjutas Teisipäev, 27. aprill 2021 kl 10:48:52 UTC+3:
> ++ cat phpdoc.dist.xml 
> <?xml version="1.0" encoding="UTF-8" ?> 
> <phpdocumentor 
> configVersion="3" 
> xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
> xmlns="https://www.phpdoc.org" 
> 
> xsi:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd" 
> > 
> <paths> 
> <output>build/api</output> 
> <cache>build/cache</cache> 
> </paths> 
> <version number="3.0.0"> 
> <api> 
> <source dsn="."> 
> <path>src</path> 
> </source> 
> </api> 
> </version> 
> </phpdocumentor> 
> ++ cat src/uses.php 
> <?php 
> 
> class Client { 
> /** 
> * @uses Server::method2() 
> */ 
> function method1(){} 
> } 
> 
> class Server { 
> function method2(){} 
> } 
> ++ phpdoc # making documentation... 
> ++ cd build/api/classes 
> ++ firefox Client.html # OUTPUT: https://pasteboard.co/JZ5l756.png 
> ++ firefox Server.html # OUTPUT: https://pasteboard.co/JZ5mB8t.png 
> 
> If Server::method2() appears in the Tags -> uses section of Client 
> documentation page (https://pasteboard.co/JZ5l756.png), 
> Client::method1() should appear in the Server documentation page 
> (https://pasteboard.co/JZ5mB8t.png). 
> Why not compare? 
> 
> Of course hoping to have understood what is written here 
> https://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.uses.pkg.html 
> 
> 
> I also tried to post on more specific newsgroups (comp.lang.php, 
> etc...), but no response :(

 🙂 🙂 🙂 🙂 🙂 🙂

[toc] | [prev] | [standalone]

Back to top | Article view | comp.programming

csiph-web