share/nitweb/views/doc/doc.html

   1 <div>
   2         <div class='col-lg-2 col-sm-3 col-xs-12'>
   3                 <ui-summary target='#summary-content' />
   4         </div>
   5         <div class='col-lg-10 col-sm-9 col-xs-12' id='summary-content' ng-class='{
   6                 "col-lg-8 col-sm-6 col-xs-12": vm.mentity.class_name == "MPackage"
   7         }'>
   8                 <div class='card'>
   9                         <div class='card-body'>
  10                                 <div ng-if='vm.doc.documentation'>
  11                                         <div ng-bind-html='vm.doc.documentation'></div>
  12                                 </div>
  13                                 <div ng-if='!vm.doc.documentation'>
  14                                         <i class='text-muted'>No documentation for this entity.</i>
  15                                 </div>
  16                         </div>
  17                 </div>
  18
  19                 <entity-list list-title='Introduced classes' list-entities='vm.intros.results'
  20                         list-object-filter='{}' ng-if='vm.mentity.class_name == "MModule"' />
  21
  22                 <entity-list list-title='Class redefinitions' list-entities='vm.redefs.results'
  23                         list-object-filter='{}' ng-if='vm.mentity.class_name == "MModule"' />
  24
  25                 <entity-list list-title='Constructors'
  26                         list-entities='vm.mentity.all_mproperties'
  27                         list-object-filter='{is_init: true}' />
  28
  29                 <entity-list list-title='Introduced properties' list-entities='vm.intros.results'
  30                         list-object-filter='{is_init: "!true"}' ng-if='vm.mentity.class_name == "MClass"' />
  31
  32                 <entity-list list-title='Redefined properties' list-entities='vm.redefs.results'
  33                         list-object-filter='{is_init: "!true"}' ng-if='vm.mentity.class_name == "MClass"' />
  34
  35         </div>
  36
  37         <div class='col-lg-2 col-sm-3 col-xs-12' ng-class='{
  38                 "hidden": vm.mentity.class_name != "MPackage"
  39         }'>
  40                 <br>
  41                 <p ng-repeat='maintainer in vm.meta.maintainers' class='lead'>
  42                         <img class='avatar' src='https://secure.gravatar.com/avatar/{{maintainer.gravatar}}?size=20&default=retro' />
  43                         <span>
  44                                 <a ui-sref='person({id: maintainer.name})'>{{maintainer.name}}</a>
  45                         </span>
  46                         <br>
  47                 </p>
  48                 <span ng-if='vm.meta.license'>
  49                         <span class='text-muted'>
  50                                 <a href='http://opensource.org/licenses/{{vm.meta.license}}'>{{vm.meta.license}}</a>
  51                                 license
  52                         </span>
  53                         <br>
  54                 </span>
  55
  56                 <div ng-if='vm.meta.homepage || vm.meta.issues'>
  57                         <h3>Links</h3>
  58                         <ul class='list-unstyled'>
  59                                 <li ng-if='vm.meta.homepage'>
  60                                         <a href='{{vm.meta.homepage}}'>Homepage</a>
  61                                 </li>
  62                                 <li ng-if='vm.meta.browse'>
  63                                         <a href='{{vm.meta.browse}}'>Source Code</a>
  64                                 </li>
  65                                 <li ng-if='vm.meta.issues'>
  66                                         <a href='{{vm.meta.issues}}'>Issues</a>
  67                                 </li>
  68                         </ul>
  69                 </div>
  70
  71                 <div ng-if='vm.meta.git || vm.mentity.stats.commits'>
  72                         <h3>Git</h3>
  73                         <ul class='list-unstyled' style='white-space: nowrap; overflow: hidden; text-overflow: ellipsis;'>
  74                                 <li ng-if='vm.meta.git'>
  75                                         <a href='{{vm.meta.git}}'>{{vm.meta.git}}</a>
  76                                 </li>
  77                                 <li ng-if='vm.mentity.stats.commits' class='text-muted'>
  78                                         <br><b>{{vm.mentity.stats.commits}} commits</b>
  79                                 </li>
  80                                 <li ng-if='vm.meta.last_date'><b class='text-muted'>Last:</b> {{vm.date(vm.meta.last_date) | date: 'medium'}}</li>
  81                                 <li ng-if='vm.meta.first_date'><b class='text-muted'>First: </b>{{vm.date(vm.meta.first_date) | date: 'medium'}}</li>
  82                         </ul>
  83                 </div>
  84
  85                 <div ng-if='vm.mentity.stats'>
  86                         <h3>Quality</h3>
  87                         <ul class='list-unstyled'>
  88                                 <li ng-if='vm.mentity.stats.documentation_score'>
  89                                         {{vm.mentity.stats.documentation_score}}% documented
  90                                 </li>
  91                                 <li ng-if='vm.mentity.stats.errors' class='text-danger'>
  92                                         {{vm.mentity.stats.errors}} errors
  93                                 </li>
  94                                 <li ng-if='vm.mentity.stats.warnings' class='text-warning'>
  95                                         {{vm.mentity.stats.warnings}} warnings
  96                                         ({{vm.mentity.stats.warnings_per_kloc}} / kloc)
  97                                 </li>
  98                         </ul>
  99                 </div>
 100
 101                 <div ng-if='vm.meta.tags.length > 0'>
 102                         <h3>Tags</h3>
 103                         <span ng-repeat='tag in vm.meta.tags'>
 104                                 <a ui-sref='tag({id: tag})'>{{tag}}</a><span ng-if='!$last'>,</span>
 105                         </span>
 106                 </div>
 107
 108                 <div ng-if='vm.parents.results.length > 0'>
 109                         <h3>Requirements</h3>
 110                         <span ng-repeat='parent in vm.parents.results'>
 111                                 <entity-link mentity='parent' /><span ng-if='!$last'>,</span>
 112                         </span>
 113                 </div>
 114
 115                 <div ng-if='vm.children.results.length > 0'>
 116                         <h3>Clients</h3>
 117                         <span ng-repeat='client in vm.children.results'>
 118                                 <entity-link mentity='client' /><span ng-if='!$last'>,</span>
 119                         </span>
 120                 </div>
 121
 122                 <div ng-if='vm.meta.contributors.length > 1'>
 123                         <h3>Contributors</h3>
 124                         <ul class='list-unstyled'>
 125                                 <li ng-repeat='contributor in vm.meta.contributors'>
 126                                         <img class='avatar' src='https://secure.gravatar.com/avatar/{{contributor.gravatar}}?size=20&default=retro' />
 127                                         <a ui-sref='person({id: contributor.name})'>
 128                                         {{contributor.name}}</a>
 129                                 </li>
 130                         </ul>
 131                 </div>
 132
 133                 <div ng-if='vm.mentity.stats'>
 134                         <h3>Stats</h3>
 135                         <ul class='list-unstyled'>
 136                                 <li>{{vm.mentity.stats.mmodules}} modules</li>
 137                                 <li>{{vm.mentity.stats.mclasses}} classes</li>
 138                                 <li>{{vm.mentity.stats.mmethods}} methods</li>
 139                                 <li>{{vm.mentity.stats.loc}} loc</li>
 140                         </ul>
 141                 </div>
 142         </div>
 143 </div>