Skip to content

Commit afc8d20

Browse files
committed
【doc】jsdoc输出fun lineNo
1 parent 83fc392 commit afc8d20

File tree

4 files changed

+20
-8
lines changed

4 files changed

+20
-8
lines changed

build/jsdocs/plugins/moduleCategories.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ exports.handlers = {
2525
e.doclet.modulecategory.className = modulecategory.name;
2626
if (!modulecategory.name.startsWith('SuperMap')) {
2727
const matchTag = e.doclet.tags.find(tag => tag.title === 'browsernamespace') || {};
28-
const prefix = matchTag.value || globalParams.namespace;
28+
const prefix = matchTag.value || (globalParams && globalParams.namespace);
2929
e.doclet.modulecategory.name = `${prefix}.${modulecategory.name}`;
3030
}
3131
e.doclet.modulecategory.des = (e.doclet.classdesc || '').split('。')[0].replace('<p>', '').replace('类', '');

build/jsdocs/template/publish.js

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -250,8 +250,15 @@ function buildNav(members, view, templatePath) {
250250
for (const key in view.navMap ) {
251251
if (Object.hasOwnProperty.call(view.navMap , key)) {
252252
const element = view.navMap[key];
253-
const m = element.methods.map(e => {
254-
return e.name;
253+
if(element.scope === 'global'){
254+
element.methods = [element];
255+
}
256+
const m = element.methods.filter((e)=>{
257+
return !e.inherited
258+
}).map(e => {
259+
var commentLength = e.comment && !e.meta.range?e.comment.split('\n').length:0;
260+
var funLineNo = e.meta.lineno + commentLength;
261+
return {name:e.name,lineNo:funLineNo,version:e.version || element.version};
255262
});
256263
if(!element.fileName && m.length>0){
257264
console.log("没有文件名的类:", element.longname,element.type,m)
@@ -432,7 +439,8 @@ function buildNavMap(members,linkto) {
432439
events: find({
433440
kind: 'event',
434441
memberof: v.longname
435-
})
442+
}),
443+
...v
436444
};
437445
}
438446
navMap[v.longname] = nav;

build/jsdocs/template/tmpl/navigation.tmpl

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ var self = this;
2525
//}
2626

2727
function build(nav,navOrder,level){
28+
2829
if(!nav){
2930
return;
3031
}
@@ -68,6 +69,7 @@ function build(nav,navOrder,level){
6869
}
6970
}
7071
function buildLi(obj){
72+
7173
?>
7274
<li class="item" file-name="<?js= obj.fileName ?>" data-name="<?js= obj.longname ?>">
7375
<span class="title" title="<?js= obj.longname ?>">
@@ -109,8 +111,10 @@ function buildLi(obj){
109111
<?js
110112

111113
obj.methods.forEach(function (v) {
114+
var commentLength = v.comment?v.comment.split('\n').length:0;
115+
var funLineNo = v.meta.lineno + commentLength;
112116
?>
113-
<li data-version= "<?js= v.version||obj.version ?>" data-name="<?js= v.longname ?>"><?js= self.linkto(v.longname, v.name) ?></li>
117+
<li data-version= "<?js= v.version||obj.version ?>" data-name="<?js= v.longname ?>" data-line="<?js= funLineNo ?>"><?js= self.linkto(v.longname, v.name) ?></li>
114118
<?js
115119
});
116120
}

src/mapboxgl/overlay/FGBLayer.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ export class FGBLayer {
7373
}
7474

7575
/**
76-
* @function DeckglLayer.prototype.onAdd
76+
* @function FGBLayer.prototype.onAdd
7777
* @param {mapboxgl.Map} map - MapBoxGL Map 对象。
7878
*/
7979
onAdd(map) {
@@ -102,13 +102,13 @@ export class FGBLayer {
102102
this._handleFeatures(extent);
103103
}
104104
/**
105-
* @function DeckglLayer.prototype.onRemove
105+
* @function FGBLayer.prototype.onRemove
106106
*/
107107
onRemove() {
108108
this.map.off('moveend', this._updateFeaturesFn);
109109
}
110110
/**
111-
* @function DeckglLayer.prototype.moveLayer
111+
* @function FGBLayer.prototype.moveLayer
112112
*/
113113
moveLayer(beforeId) {
114114
this.map.moveLayer(this.layerId, beforeId);

0 commit comments

Comments
 (0)