autogsdoc - ক্লাউডে অনলাইন

কার্যক্রম:

NAME এর

autogsdoc - GNUstep API ডকুমেন্টেশন জেনারেটর এবং XML->HTML রূপান্তরকারী

সাইনোপিসিস

autogsdoc [-নথি পত্র ফাইলের নাম] [-Html তৈরি করুন হ্যাঁ|না] [- ক্লিন হ্যাঁ|না] [-ক্লিন টেমপ্লেট
হ্যাঁ|না] [-নির্ভরতা উপেক্ষা করুন হ্যাঁ|না] [-নির্ভরতা তৈরি করুন হ্যাঁ|না] [-নির্ভরতা দেখান হ্যাঁ|না]
[-হেডারডিরেক্টরি পথ] [- ডকুমেন্টেশন ডাইরেক্টরি পথ] [-ঘোষিত অবস্থান] [-প্রকল্প
খেতাব] [-মান হ্যাঁ|না] [-Document AllInstance Variables হ্যাঁ|না]
[-ডকুমেন্ট ইনস্ট্যান্স ভেরিয়েবল হ্যাঁ|না] [-ইনস্ট্যান্স ভেরিয়েবলসএন্ড হ্যাঁ|না] [- ধ্রুবক টেমপ্লেট
ফাইলের নাম] [-ফাংশন টেমপ্লেট ফাইলের নাম] [-ম্যাক্রো টেমপ্লেট ফাইলের নাম] [-টাইপডেফ টেমপ্লেট
ফাইলের নাম] [-ভেরিয়েবল টেমপ্লেট ফাইলের নাম] [-সিস্টেম প্রজেক্ট স্ট্রিং] [-স্থানীয় প্রকল্প স্ট্রিং]
[-প্রকল্প dictString] [-ভেরবুস হ্যাঁ|না] [- সতর্ক করুন হ্যাঁ|না] [- ওয়ার্ডম্যাপ dictString] [নথি পত্র]

বর্ণনাঃ

Autogsdoc টুল হল একটি কমান্ড-লাইন ইউটিলিটি যা ডেভেলপারদের রেফারেন্স তৈরি করতে সাহায্য করে
GNUstep API-এর জন্য ডকুমেন্টেশন। এটি বিকাশকারীদের অন্য লিখতে এবং বজায় রাখতে সক্ষম করে
XML-এ ডকুমেন্টেশন এবং এটি HTML-এ রূপান্তরিত করুন। বিস্তারিতভাবে, autogsdoc করবে:

- ক্লাস, বিভাগগুলির সর্বজনীন ইন্টারফেসগুলি বর্ণনা করে বিশেষ মন্তব্যগুলি বের করুন,
অবজেক্টিভ সি সোর্স কোড থেকে প্রোটোকল, ফাংশন এবং ম্যাক্রো (হেডার ফাইল এবং
ঐচ্ছিকভাবে উৎস ফাইল) GSDoc XML ফাইলে।

- GSDoc XML ফাইলগুলিকে রূপান্তর করুন, সোর্স কোড থেকে তৈরি হোক বা ম্যানুয়ালি লেখা হোক
বিকাশকারীরা, HTML এ।

- GSDoc XML ফাইল সেটের উপর ভিত্তি করে সূচকগুলি তৈরি করুন এবং সেগুলিকে HTML-এ রূপান্তর করুন৷

এটির সবচেয়ে সাধারণ ব্যবহার হল এক বা একাধিক হেডার ফাইলের নাম দিয়ে কমান্ড চালানো
আর্গুমেন্টস... টুলটি স্বয়ংক্রিয়ভাবে সংশ্লিষ্ট সোর্স ফাইলকে একই সাথে পার্স করবে
শিরোনাম হিসাবে ডিরেক্টরি (বা বর্তমান ডিরেক্টরি, অথবা ব্যবহার করে নির্দিষ্ট ডিরেক্টরি
DocumentationDirectory ডিফল্ট), এবং আউটপুট হিসাবে GSDoc এবং HTML ফাইল তৈরি করে। ভালোর জন্য
ফলাফল এই মোড উৎস ফাইল ধারণকারী ডিরেক্টরি থেকে চালানো উচিত. (বিঃদ্রঃ
যেহেতু C হল অবজেক্টিভ C এর একটি উপসেট, এই টুলটি নথির ফাংশন এবং কাজ করতে পারে
প্লেইন সি উৎসে অন্যান্য সি কাঠামো।)

GSDoc ফাইলগুলি সরাসরি অতিরিক্ত বা নিজের দ্বারাও দেওয়া যেতে পারে এবং রূপান্তরিত হবে
HTML থেকে GSDoc HTML ডকুমেন্টেশন বা দেখুন gsdoc(7) তথ্যের জন্য ম্যান পেজ
GSDoc বিন্যাস।

অবশেষে, কমান্ড লাইনে HTML ফাইল দেওয়া যেতে পারে। এর অন্যান্য অংশের ক্রস-রেফারেন্স
তাদের মধ্যে পাওয়া কোড ডকুমেন্টেশন যা পাওয়া যায় তার উপর ভিত্তি করে পুনরায় লেখা হবে
বর্তমানে প্রকল্প।

উৎস কোড মার্কআপ

সোর্স কোড পার্সার স্বয়ংক্রিয়ভাবে GSDoc নথি তৈরি করবে যাতে পদ্ধতিগুলি তালিকাভুক্ত হয়
উত্স ফাইলগুলিতে পাওয়া ক্লাসগুলি, এবং এটি বিশেষভাবে বিন্যাস করা থেকে পাঠ্য অন্তর্ভুক্ত করবে
উৎস ফাইল থেকে মন্তব্য.

স্ল্যাশ দিয়ে শুরু হওয়া যেকোনো মন্তব্য এবং দুই সাধারণ স্ল্যাশ এবং একক এর পরিবর্তে তারকাচিহ্ন
তারকাচিহ্ন, ক্লাস বা পদ্ধতির বর্ণনা হিসাবে ব্যবহার করার জন্য GSDoc মার্কআপ হিসাবে নেওয়া হয়
এটা অনুসরণ এই মন্তব্য পাঠ্য পুনরায় ফর্ম্যাট করা হয় এবং তারপর আউটপুটে ঢোকানো হয়।
যেখানে একই আইটেমের সাথে একাধিক মন্তব্য যুক্ত থাকে, সেখানে তারা a এর সাথে যুক্ত হয়
লাইন বিরতি ( প্রয়োজনে প্রতিটির মধ্যে।

টুলটি সহজেই প্রদান করে প্রোগ্রামের পাশাপাশি লাইব্রেরি নথিভুক্ত করতে ব্যবহার করা যেতে পারে
প্রোগ্রামের main() ফাংশন ধারণকারী উৎস ফাইলের নাম - এটি লাগে
যে ফাংশন থেকে বিশেষ মন্তব্য এবং একটি হিসাবে তাদের সন্নিবেশ বিশেষভাবে তাদের পরিচালনা করে
নথির প্রথম অধ্যায়ের শেষে বিভাগ (এটি যদি প্রথম অধ্যায় তৈরি করে
প্রয়োজনীয়)।

অপশন সমূহ বিভাগে বর্ণনা করা হয় আর্গুমেন্ট এবং ডিফল্টে নিচে.

অতিরিক্ত মার্কআপ

কিছু ক্ষেত্রে বিশেষ অতিরিক্ত প্রক্রিয়াকরণ করা হয়, প্রধানত
সোর্স ফাইলে পাওয়া প্রথম মন্তব্য, যেখান থেকে GSDoc মার্কআপের বিভিন্ন অংশ হতে পারে
বের করে আউটপুট নথিতে উপযুক্ত স্থানে স্থাপন করা হয়েছে -

Autogsdoc উৎস:
যে কোন লাইনে যেখানে Autogsdoc উৎস: পাওয়া যায়, লাইনের অবশিষ্ট অংশটি a হিসাবে নেওয়া হয়
সোর্স ফাইলের নাম ব্যবহার করার পরিবর্তে অনুমান করা যে প্রতিটি .h ফাইল
প্রক্রিয়াকৃত একই নামের একটি .m ফাইল ব্যবহার করে। আপনি একাধিক সরবরাহ করতে পারেন Autogsdoc উৎস:
লাইন যেখানে একটি হেডার ফাইল আইটেম ঘোষণা করে যেগুলি একাধিক উৎস ফাইলে সংজ্ঞায়িত করা হয়।
যদি একটি ফাইলের নাম পরম হয়, তবে এটি সরবরাহ করা হিসাবে ব্যবহার করা হয়। অন্য দিকে যদি, এটি একটি
আপেক্ষিক পথ, সফ্টওয়্যারটি প্রথমে অবস্থানের সাথে সম্পর্কিত সোর্স ফাইলের সন্ধান করে
শিরোনাম ফাইলের, এবং যদি সেখানে পাওয়া না যায়, বর্তমান ডিরেক্টরির সাথে সম্পর্কিত যা
autogsdoc চলছে, এবং অবশেষে দ্বারা নির্দিষ্ট করা ডিরেক্টরির সাথে সম্পর্কিত
ডকুমেন্টেশন ডাইরেক্টরি ডিফল্ট.


নথির বিষয়বস্তুর একটি বিমূর্ত... GSDoc আউটপুটের মাথায় স্থাপন করা হয়েছে।


কোডের লেখকের একটি বিবরণ - কেস পরিচালনা করার জন্য পুনরাবৃত্তি করা যেতে পারে যেখানে ক
নথির একাধিক লেখক আছে। GSDoc আউটপুটের মাথায় স্থাপন করা হয়েছে। একটি সাহায্য হিসাবে
উৎসের পঠনযোগ্যতা, কিছু বিশেষ অতিরিক্ত প্রক্রিয়াকরণ সম্পর্কিত সঞ্চালিত হয়
নথি লেখক - ফর্মের যেকোনো লাইন 'লেখক: নাম ', অথবা দ্বারা:
নাম ', বা 'লেখক: নাম' বা 'দ্বারা: নাম' স্বীকৃত হবে এবং
একটি রূপান্তরিত লেখক উপাদান, সম্ভবত একটি ধারণকারী ইমেইল উপাদান।


নথির মূল অংশের শেষের ঠিক আগে GSDoc আউটপুটে স্থাপন করা হয়েছে - উদ্দেশ্য
পরিশিষ্ট, সূচক ইত্যাদির জন্য ব্যবহার করা হবে।


কোনো জেনারেট করা ক্লাস ডকুমেন্টেশনের আগে অবিলম্বে স্থাপন করা হয়েছে... ব্যবহার করার উদ্দেশ্যে
নথিভুক্ত করা কোডটি কীভাবে কাজ করে তার সামগ্রিক বিবরণ প্রদান করতে। যে কোন
একটি প্রোগ্রামের প্রধান() ফাংশনের জন্য ডকুমেন্টেশন শেষে একটি বিভাগ হিসাবে সন্নিবেশ করা হয়
এই অধ্যায়ের।


নথির বিষয়বস্তুর কপিরাইট... GSDoc আউটপুটের মাথায় রাখা হয়েছে।
উৎসের পঠনযোগ্যতা একটি সাহায্য হিসাবে, কিছু বিশেষ অতিরিক্ত প্রক্রিয়াকরণ হয়
সঞ্চালিত - 'কপিরাইট (সি) টেক্সট' ফর্মের যেকোনো লাইন স্বীকৃত এবং রূপান্তরিত হবে
একটি থেকে কপি উপাদান।


নথির সংশোধনের তারিখ... GSDoc আউটপুটের মাথায় স্থাপন করা হয়েছে। যদি
এটি বাদ দেওয়া হয়েছে টুলটি RCS তারিখ ট্যাগ থেকে একটি মান তৈরি করার চেষ্টা করবে (যদি
উপলব্ধ)।


শরীরের শুরুতে নথিতে ঢোকানো ... জন্য প্রদান করার উদ্দেশ্যে
ভূমিকা বা বিষয়বস্তু পাতা ইত্যাদি


নথির শিরোনাম... GSDoc আউটপুটের মাথায় স্থাপন করা হয়েছে। এই বাদ দিলে
টুলটি তার নিজস্ব একটি (সম্ভবত খারাপ) শিরোনাম তৈরি করবে - তাই আপনার এটি অন্তর্ভুক্ত করা উচিত
ম্যানুয়ালি মার্কআপ করুন।


নথির সংস্করণ শনাক্তকারী... GSDoc আউটপুটের মাথায় রাখা হয়েছে। যদি
এটি বাদ দেওয়া হয়েছে টুলটি আরসিএস রিভিশন ট্যাগ থেকে একটি মান তৈরি করার চেষ্টা করবে (যদি
উপলব্ধ)।

NB এইমাত্র বর্ণিত মার্কআপটি ক্লাস, বিভাগ বা প্রোটোকল ডকুমেন্টেশনের মধ্যে ব্যবহার করা যেতে পারে
... যদি তাই হয়, এটা বের করা হয় এবং ক্লাসের জন্য বাকি ডকুমেন্টেশনে মোড়ানো হয়
ক্লাসের অধ্যায় হিসাবে। ক্লাস ডকুমেন্টেশন বাকি সাধারণত ঢোকানো হয়
অধ্যায়ের শেষে, কিন্তু পরিবর্তে এর জায়গায় প্রতিস্থাপিত হতে পারে ছদ্ম-
মধ্যে উপাদান উপাদান

পদ্ধতি মার্কআপ

একটি পদ্ধতির বিবরণের জন্য পাঠ্য প্রদান করতে ব্যবহৃত মন্তব্যগুলিতে, নিম্নলিখিত মার্কআপটি হল
পাঠ্য থেকে সরানো হয়েছে এবং বিশেষভাবে পরিচালনা করা হয়েছে -


পদ্ধতিটি ক্লাসের জন্য মনোনীত প্রাথমিক হিসাবে চিহ্নিত করা হয়েছে।


পদ্ধতিটি এমন একটি হিসাবে চিহ্নিত করা হয়েছে যা উপশ্রেণীগুলিকে অবশ্যই ওভাররাইড করতে হবে (যেমন একটি বিমূর্ত
পদ্ধতি)।


পদ্ধতিটি এমন একটি হিসাবে চিহ্নিত করা হয়েছে যা সাবক্লাসের উচিত না অগ্রাহ্য করা.


মার্কআপ বর্ণনা থেকে সরানো হয় এবং স্থাপন করা হয় পরে এটি GSDoc আউটপুটে -
যাতে পদ্ধতিটি নির্দিষ্ট করা (বা মানানসই নয়) হিসাবে বর্ণনা করা হয়
মান।

স্বয়ংক্রিয় মার্কআপ

সাধারনত, কমেন্টের টেক্সটকে স্ট্যান্ডার্ডাইজ করার জন্য আবার ফরম্যাট করা হয় এবং সুন্দরভাবে ইন্ডেন্ট করা হয়...
রিফরম্যাটিং হল না একটি ভিতরে কোনো টেক্সট সঞ্চালিত উপাদান যখন লেখাটি হয়
রিফরম্যাট করা হলে, এটি হোয়াইটস্পেসে বিভক্ত "শব্দগুলি" বিভক্ত করা হয় যা পরে সাপেক্ষে হয়
কিছু অতিরিক্ত প্রক্রিয়াকরণ...

কিছু সুপরিচিত ধ্রুবক যেমন YES, NO এবং nil এর মধ্যে আবদ্ধ থাকে ...
মার্কআপ.

পদ্ধতির বর্ণনার মধ্যে পদ্ধতি আর্গুমেন্টের নামগুলি এতে আবদ্ধ রয়েছে ...
<প্রথমেই / var> মার্কআপ।

পদ্ধতির নাম (একটি প্লাস বা বিয়োগ দিয়ে শুরু) আবদ্ধ করা হয়েছে ...
মার্কআপ. যেমন "-init" (উদ্ধৃতি ছাড়া) একটি GSDoc রেফারেন্সে মোড়ানো হবে
উপাদান বর্তমান ক্লাসের init পদ্ধতি নির্দেশ করতে বা, শুধুমাত্র একটি পরিচিত ক্লাস হলে
একটি init পদ্ধতি ছিল, এটি সেই শ্রেণীর পদ্ধতি উল্লেখ করবে। বিষয়টি খেয়াল করুন
পদ্ধতির নামটি স্বীকৃত হওয়ার জন্য অবশ্যই হোয়াইটস্পেস দ্বারা বেষ্টিত হতে হবে (যদিও একটি কমা,
ফুলস্টপ, বা স্পেসিফায়ারের শেষে সেমিকোলন হোয়াইটস্পেসের মতো কাজ করবে)।

ক্লাসের নাম সহ মেথড স্পেসিফায়ার (বর্গ বন্ধনী দিয়ে শুরু এবং শেষ)
মধ্যে আবদ্ধ হয় ... মার্কআপ. যেমন '[NSobject-init]', একটি তৈরি করবে
এনএসওবজেক্টের init পদ্ধতির রেফারেন্স (হয় ক্লাস সঠিক, বা এর যেকোনো একটি
বিভাগ), যখন '[(NSCopying)-copyWithZone:]', একটি পদ্ধতির রেফারেন্স তৈরি করে
NSCopying প্রোটোকল। মনে রাখবেন যে বর্গাকার বন্ধনীগুলির মধ্যে কোনও স্পেস উপস্থিত হওয়া উচিত নয়
এই স্পেসিফায়ারে। প্রোটোকলের নামগুলি এর পরিবর্তে বৃত্তাকার বন্ধনীতে আবদ্ধ
প্রথাগত কোণ বন্ধনী, কারণ GSDoc একটি XML ভাষা, এবং XML কোণ ব্যবহার করে
বিশেষভাবে বন্ধনী।

'main()' ছাড়া অন্য ফাংশনের নাম ('()' দিয়ে শেষ হয়) ...
মার্কআপ. যেমন "NSLogv()" (উদ্ধৃতি ছাড়া) একটি GSDoc এ মোড়ানো হবে
NSLog ফাংশনের ডকুমেন্টেশন নির্দেশ করার জন্য রেফারেন্স উপাদান। ঘটনাটি নোট করুন
যে ফাংশনের নামটি অবশ্যই হোয়াইটস্পেস দ্বারা বেষ্টিত হতে হবে (যদিও একটি কমা, ফুলস্টপ, বা
নির্দিষ্টকরণের শেষে সেমিকোলন একটি হোয়াইটস্পেস টার্মিনেটর হিসাবে কাজ করবে)।

যুক্তি এবং পূর্ব নির্ধারিত

টুলটি নির্দিষ্ট ব্যবহারকারীর ডিফল্ট গ্রহণ করে (যা অবশ্যই কমান্ড-লাইন হিসাবে সরবরাহ করা যেতে পারে
ডিফল্ট নামের আগে '-' লিখে আর্গুমেন্ট এবং পরে মান দিয়ে, যেমন ইন
-পরিষ্কার হ্যাঁ):

পরিষ্কার
যদি এই বুলিয়ান মানটি হ্যাঁ সেট করা হয়, তবে ডকুমেন্টেশন তৈরি করার পরিবর্তে,
টুলটি প্রকল্পে উত্পন্ন সমস্ত GSDoc ফাইল এবং উত্পন্ন সমস্ত html ফাইল সরিয়ে দেয়
তাদের থেকে (পাশাপাশি তালিকাভুক্ত GSDoc ফাইলগুলি থেকে তৈরি করা হবে)
স্পষ্টভাবে), এবং অবশেষে প্রকল্প সূচক ফাইলটি সরিয়ে দেয়। এর একমাত্র ব্যতিক্রম
সেই টেমপ্লেট GSDoc ফাইলগুলি (অর্থাৎ "-কনস্ট্যান্ট টেমপ্লেট ..." ব্যবহার করে নির্দিষ্ট করা হয়েছে,
"-ফাংশন টেমপ্লেট ..." আর্গুমেন্ট ইত্যাদি) মুছে ফেলা হয় না যদি না ক্লিন টেমপ্লেট
পতাকা সেট করা হয়।

ক্লিন টেমপ্লেট
এই পতাকাটি নির্দিষ্ট করে যে টেমপ্লেট GSDoc ফাইলগুলি অন্যের সাথে মুছে ফেলা হবে কিনা
ফাইলগুলি যখন পরিষ্কার বিকল্পটি নির্দিষ্ট করা থাকে। ডিফল্ট তাদের সরানো হবে না জন্য
... যেহেতু এই টেমপ্লেটগুলি ম্যানুয়ালি উত্পাদিত হতে পারে এবং কেবলমাত্র ডেটা ঢোকানো হয়েছে৷
তাদের মধ্যে।

ধ্রুবক টেমপ্লেট
একটি টেমপ্লেট নথির নাম উল্লেখ করুন যার মধ্যে ধ্রুবক সম্পর্কে ডকুমেন্টেশন রয়েছে
প্রকল্পের সমস্ত ফাইল থেকে সন্নিবেশ করা উচিত। তে ধ্রুবক থাকলে এটি কার্যকর
সোর্স কোড অনেকগুলি ফাইলের চারপাশে ছড়িয়ে ছিটিয়ে রয়েছে এবং আপনাকে সেগুলিকে একটিতে গোষ্ঠীভুক্ত করতে হবে
স্থান আপনি নিশ্চিত করার জন্য দায়ী যে মৌলিক টেমপ্লেট নথি (যার মধ্যে
পৃথক ধ্রুবক ডকুমেন্টেশন ঢোকানো হয়) আপনার অন্যান্য সমস্ত তথ্য রয়েছে
চাই, কিন্তু একটি সুবিধা হিসাবে autogsdoc একটি সাধারণ টেমপ্লেট তৈরি করবে (যা আপনি করতে পারেন
তারপর ফাইলটি বিদ্যমান না থাকলে আপনার জন্য সম্পাদনা করুন। সন্নিবেশ অবিলম্বে সঞ্চালিত হয়
পূর্বে পিছনে উপাদান (বা যদি এটি বিদ্যমান না থাকে, অবিলম্বে শেষের আগে
শরীর উপাদান) টেমপ্লেটে।

ঘোষিত
শিরোনাম খুঁজে পাওয়া হিসাবে নথিভুক্ত করা হবে যেখানে উল্লেখ করুন. প্রকৃত নাম উত্পাদিত
ডকুমেন্টেশনে শিরোনাম ফাইল নামের শেষ উপাদান যোগ করে গঠিত হয়
এই ডিফল্ট মান. এই ডিফল্ট নির্দিষ্ট না হলে, এর পুরো নাম
হেডার ফাইল (কমান্ড লাইনে সরবরাহ করা হয়েছে), হেডারডিরেক্টরি ডিফল্ট সহ
prepended, ব্যবহৃত হয়। এটির একটি সাধারণ ব্যবহার '"-ঘোষিত ফাউন্ডেশন" হতে পারে যখন
GNUstep বেস লাইব্রেরির জন্য ডকুমেন্টেশন তৈরি করা হচ্ছে। এর ফলে হবে
ডকুমেন্টেশন বলছে যে NSString 'Foundation/NSString.h' এ ঘোষণা করা হয়েছে

Document AllInstance Variables
এই পতাকা আপনাকে সমস্ত উদাহরণ ভেরিয়েবলের জন্য ডকুমেন্টেশন তৈরি করার অনুমতি দেয়। সাধারণত,
শুধুমাত্র স্পষ্টভাবে ঘোষিত 'জনসাধারণ' বা 'সুরক্ষিত' নথিভুক্ত করা হবে।

ডকুমেন্ট ইনস্ট্যান্স ভেরিয়েবল
এই পতাকা আপনাকে উদাহরণ ভেরিয়েবলের জন্য ডকুমেন্টেশন সম্পূর্ণরূপে বন্ধ করার অনুমতি দেয়।
সাধারণত, স্পষ্টভাবে ঘোষিত 'পাবলিক' বা 'সুরক্ষিত' উদাহরণ ভেরিয়েবল হবে
নথিভুক্ত।

ইনস্ট্যান্স ভেরিয়েবলসএন্ড
এই পতাকা, সেট করা হলে, ইনস্ট্যান্স ভেরিয়েবল ডকুমেন্টেশন স্থাপনের জন্য HTML জেনারেটরকে নির্দেশ করে
শুরুর পরিবর্তে ক্লাসের শেষে। আপনি অনেক ব্যবহার করলে এটি দরকারী
সুরক্ষিত দৃষ্টান্ত ভেরিয়েবল যা শুধুমাত্র গৌণ স্বার্থ হতে যাচ্ছে
ক্লাসের সাধারণ ব্যবহারকারীরা।

ডকুমেন্টেশন ডাইরেক্টরি
উত্পন্ন ডকুমেন্টেশন স্থাপন করা হবে যে ডিরেক্টরি নির্দিষ্ট করতে ব্যবহার করা যেতে পারে।
যদি এটি সেট করা না থাকে, আউটপুট বর্তমান ডিরেক্টরিতে স্থাপন করা হয়। এই ডিরেক্টরি এছাড়াও
সোর্স ফাইলগুলি সনাক্ত করার জন্য একটি শেষ অবলম্বন হিসাবে ব্যবহৃত হয় (হেডার নয়), এবং আরও গুরুত্বপূর্ণভাবে, এটি
হিসাবে ব্যবহৃত হয় প্রথম এবং কেবল পাস করা যেকোন .gsdoc ফাইলগুলি সনাক্ত করতে অবলম্বন করুন৷
কমান্ড লাইন। এই ফাইলগুলির জন্য দেওয়া কোনো পাথ তথ্য হয় অপসারিত এবং তারা
'DocumentationDirectory'-এ অনুসন্ধান করা হয়েছে (যদিও তারা নাও থাকতে পারে
স্বয়ংক্রিয় উৎপন্ন)।

নথি পত্র
একটি সম্পত্তি তালিকা অ্যারে হিসাবে ফাইল নামের একটি তালিকা ধারণকারী একটি ফাইলের নাম নির্দিষ্ট করে
(নাম1, নাম2,...) বিন্যাস এটি উপস্থিত থাকলে, প্রোগ্রাম আর্গুমেন্ট তালিকায় ফাইলের নাম
উপেক্ষা করা হয় এবং এই ফাইলের নামগুলি প্রক্রিয়া করার জন্য নামের তালিকা হিসাবে ব্যবহৃত হয়।

ফাংশন টেমপ্লেট
একটি টেমপ্লেট নথির নাম উল্লেখ করুন যার মধ্যে ফাংশন সম্পর্কে ডকুমেন্টেশন রয়েছে
প্রকল্পের সমস্ত ফাইল থেকে সন্নিবেশ করা উচিত। এটি কার্যকর যদি ফাংশন উত্স
কোড অনেক ফাইলের চারপাশে ছড়িয়ে ছিটিয়ে আছে, এবং আপনাকে এটিকে এক জায়গায় গ্রুপ করতে হবে। তুমি
মৌলিক টেমপ্লেট নথি নিশ্চিত করার জন্য দায়ী (যার মধ্যে ব্যক্তি
ফাংশন ডকুমেন্টেশন সন্নিবেশ করা হয়) আপনি চান অন্যান্য সমস্ত তথ্য রয়েছে, কিন্তু
একটি সুবিধা হিসাবে autogsdoc একটি সাধারণ টেমপ্লেট তৈরি করবে (যা আপনি তখন সম্পাদনা করতে পারেন)
আপনার জন্য যদি ফাইলটি বিদ্যমান না থাকে। সন্নিবেশ আগে অবিলম্বে সঞ্চালিত হয় পিছনে
উপাদান (বা যদি এটি বিদ্যমান না থাকে, অবিলম্বে শেষের আগে শরীর উপাদান) মধ্যে
টেমপ্লেট

এইচটিএমএল তৈরি করুন
HTML আউটপুট তৈরি করা হবে কিনা তা নির্দিষ্ট করতে ব্যবহার করা যেতে পারে। ডিফল্ট হ্যাঁ.

হেডার ডাইরেক্টরি
হেডার ফাইলের জন্য অনুসন্ধান করা ডিরেক্টরি নির্দিষ্ট করতে ব্যবহার করা যেতে পারে। যখন সরবরাহ করা হয়,
এই মানটি আপেক্ষিক শিরোনাম নামগুলির সাথে পূর্বে লেখা হয়, অন্যথায় আপেক্ষিক শিরোলেখ নামগুলি
বর্তমান ডিরেক্টরির সাপেক্ষে ব্যাখ্যা করা হয়। হেডার ফাইল পরম হিসাবে নির্দিষ্ট করা হয়েছে
পাথ এই ডিফল্ট দ্বারা প্রভাবিত হয় না.

নির্ভরতা উপেক্ষা করুন
একটি বুলিয়ান মান যা নির্দিষ্ট করতে ব্যবহার করা যেতে পারে যে প্রোগ্রামটি ফাইলটিকে উপেক্ষা করবে
পরিবর্তনের সময় এবং যাইহোক ফাইলগুলি পুনরায় তৈরি করুন। সঙ্গে একযোগে ব্যবহারের জন্য প্রদান করা হয়
'মেক' সিস্টেম, যা নির্ভরতা পরীক্ষা নিজেই পরিচালনা করবে বলে আশা করা হচ্ছে।

স্থানীয় প্রকল্প
এই মান স্থানীয় বহিরাগত প্রকল্পের স্বয়ংক্রিয় অন্তর্ভুক্তি নিয়ন্ত্রণ করতে ব্যবহৃত হয়
চূড়ান্ত নথির আউটপুটে ক্রস-রেফারেন্স তৈরির জন্য ইন্ডেক্সিং সিস্টেম। যদি
'কোনটি নয়' তে সেট করুন, তারপরে কোনও স্থানীয় প্রকল্পের উল্লেখ করা হয় না, অন্যথায়, 'স্থানীয়'
GNUstep ডকুমেন্টেশন ডিরেক্টরিটি '.igsdoc' সহ ফাইলগুলির জন্য পুনরাবৃত্তিমূলকভাবে অনুসন্ধান করা হয়
এক্সটেনশন, এবং সেই ফাইলগুলি থেকে ইনডেক্সিং তথ্য ব্যবহার করা হয়। এর মান
স্ট্রিং ক্রস রেফারেন্সে ফাইলের নাম তৈরি করতেও ব্যবহৃত হয়... যদি এটি একটি হয়
খালি স্ট্রিং, ব্যবহার করার পথটিকে একই ডিরেক্টরির একটি ফাইল বলে ধরে নেওয়া হয় যেখানে
igsdoc ফাইল পাওয়া গেছে, অন্যথায় এটি সূচকে নামের উপসর্গ হিসাবে ব্যবহৃত হয়। এনবি
বর্তমানে যে প্রকল্পটি নথিভুক্ত করা হচ্ছে সেই একই নামের স্থানীয় প্রকল্পগুলো হবে না
এই প্রক্রিয়া দ্বারা অন্তর্ভুক্ত করা হবে. আপনি যদি এই জাতীয় প্রকল্পগুলি অন্তর্ভুক্ত করতে চান তবে আপনাকে অবশ্যই তা করতে হবে
স্পষ্টভাবে ব্যবহার করে -প্রকল্প ...

ম্যাক্রো টেমপ্লেট
একটি টেমপ্লেট নথির নাম উল্লেখ করুন যেখানে ম্যাক্রো সম্পর্কে ডকুমেন্টেশন থাকা উচিত
প্রকল্পের সমস্ত ফাইল থেকে সন্নিবেশ করা হবে। ম্যাক্রো কোড ছড়িয়ে ছিটিয়ে থাকলে এটি কার্যকর
অনেক ফাইলের চারপাশে, এবং আপনাকে এটিকে এক জায়গায় গ্রুপ করতে হবে। আপনি জন্য দায়ী
নিশ্চিত করা যে মৌলিক টেমপ্লেট নথি (যার মধ্যে পৃথক ম্যাক্রো ডকুমেন্টেশন
ঢোকানো হয়) আপনি চান অন্যান্য সমস্ত তথ্য রয়েছে, কিন্তু একটি সুবিধা হিসাবে
autogsdoc আপনার জন্য একটি সাধারণ টেমপ্লেট তৈরি করবে (যা আপনি তখন সম্পাদনা করতে পারেন) যদি
ফাইল বিদ্যমান নেই. সন্নিবেশ আগে অবিলম্বে সঞ্চালিত হয় পিছনে উপাদান (বা যদি
যে অস্তিত্ব নেই, অবিলম্বে শেষের আগে শরীর
উপাদান) টেমপ্লেটে।

নির্ভরতা তৈরি করুন
তৈরির জন্য নির্ভরতা তথ্য আউটপুট করার জন্য একটি ফাইলের নাম ব্যবহার করা হবে। এই লাগবে
এর নির্ভরতা হিসাবে প্রকল্পের জন্য পরিচিত সমস্ত শিরোনাম এবং উত্স ফাইল তালিকাভুক্ত করার ফর্ম
প্রকল্পের নাম ('প্রকল্প' দেখুন)।

প্রকল্প
এই প্রকল্পের নাম উল্লেখ করতে ব্যবহার করা যেতে পারে... সূচকের নাম নির্ধারণ করে
তথ্য সক্ষম করার জন্য ডকুমেন্টেশনের অংশ হিসাবে উত্পাদিত রেফারেন্স ফাইল
অন্যান্য প্রকল্প এই প্রকল্পের আইটেম ক্রস রেফারেন্স.

প্রকল্প
এই মানটি igsdoc-এর পথ সম্বলিত অভিধান হিসাবে সরবরাহ করা হতে পারে
বহিরাগত প্রকল্প দ্বারা ব্যবহৃত সূচক/রেফারেন্স ফাইল, মান সহ মানচিত্র ব্যবহার করা হবে
ইনডেক্সে পাওয়া ফাইলের নাম। উদাহরণস্বরূপ, যদি একটি প্রকল্প সূচক (igsdoc) ফাইল
বলে যে 'Foo' ক্লাসটি 'Foo' ফাইলে পাওয়া যায় এবং এর সাথে যুক্ত পথ
সেই প্রজেক্ট ইনডেক্স হল '/usr/share/doc/proj', তারপর জেনারেট করা html আউটপুট রেফারেন্স করতে পারে
ক্লাসটি '/usr/share/doc/prj/Foo.html'-এ রয়েছে। উল্লেখ্য যে একটি অভিধান হতে পারে
স্ট্যান্ডার্ড প্রপার্টিলিস্ট ফরম্যাট ব্যবহার করে কমান্ড লাইনে দেওয়া হয়েছে (এক্সএমএল নয়
OS X এর বিন্যাস), লাইন-বিভাজক হিসাবে সেমিকোলন ব্যবহার করে এবং এটিকে এককভাবে আবদ্ধ করে
কোট।

নির্ভরতা দেখান
একটি বুলিয়ান মান যা নির্দিষ্ট করতে ব্যবহার করা যেতে পারে যে প্রোগ্রামটি কোন ফাইলগুলি লগ করবে
অন্যান্য ফাইলের উপর তাদের নির্ভরতার কারণে পুনরায় তৈরি করা হচ্ছে।

স্ট্যান্ডার্ড
প্রোগ্রামটি সম্পর্কে তথ্য সন্নিবেশ করা উচিত কিনা তা নির্দিষ্ট করতে ব্যবহৃত একটি বুলিয়ান মান
ডকুমেন্টেশন মধ্যে মান সম্মতি. এই শুধুমাত্র যখন ব্যবহার করা উচিত
GNUstep লাইব্রেরি এবং টুলগুলিকে নথিভুক্ত করা যেমন এটি অনুমান করে যে কোডটি
নথিভুক্ত করা GNUstep এর অংশ এবং সম্ভবত OpenStep মান মেনে চলে
বা MacOS-X সামঞ্জস্যপূর্ণ পদ্ধতি প্রয়োগ করে।

সিস্টেম প্রকল্প
এই মানটি সিস্টেম বহিরাগত প্রকল্পগুলির স্বয়ংক্রিয় অন্তর্ভুক্তি নিয়ন্ত্রণ করতে ব্যবহৃত হয়
চূড়ান্ত নথির আউটপুটে ক্রস-রেফারেন্স তৈরির জন্য ইন্ডেক্সিং সিস্টেম। যদি
'কোনও' তে সেট করুন, তারপরে কোনও সিস্টেম প্রজেক্ট রেফারেন্স করা হয় না, অন্যথায়, 'সিস্টেম'
GNUstep ডকুমেন্টেশন ডিরেক্টরিটি '.igsdoc' সহ ফাইলগুলির জন্য পুনরাবৃত্তিমূলকভাবে অনুসন্ধান করা হয়
এক্সটেনশন, এবং সেই ফাইলগুলি থেকে ইনডেক্সিং তথ্য ব্যবহার করা হয়। এর মান
স্ট্রিং ক্রস রেফারেন্সে ফাইলের নাম তৈরি করতেও ব্যবহৃত হয়... যদি এটি একটি হয়
খালি স্ট্রিং, ব্যবহার করার পথটিকে একই ডিরেক্টরির একটি ফাইল বলে ধরে নেওয়া হয় যেখানে
igsdoc ফাইল পাওয়া গেছে, অন্যথায় এটি সূচকে নামের উপসর্গ হিসাবে ব্যবহৃত হয়। এনবি
বর্তমানে নথিভুক্ত করা প্রকল্প হিসাবে একই নামের সিস্টেম প্রকল্প হবে না
এই প্রক্রিয়া দ্বারা অন্তর্ভুক্ত করা হবে. আপনি যদি এই জাতীয় প্রকল্পগুলি অন্তর্ভুক্ত করতে চান তবে আপনাকে অবশ্যই তা করতে হবে
স্পষ্টভাবে ব্যবহার করে -প্রকল্প ...

টাইপডেফ টেমপ্লেট
একটি টেমপ্লেট নথির নাম উল্লেখ করুন যেখানে টাইপডেফ সম্পর্কে ডকুমেন্টেশন থাকা উচিত
প্রকল্পের সমস্ত ফাইল থেকে সন্নিবেশ করা হবে। টাইপডেফ সোর্স কোড হলে এটি কার্যকর
অনেক ফাইল চারপাশে ছড়িয়ে ছিটিয়ে আছে, এবং আপনাকে এটিকে এক জায়গায় গোষ্ঠীভুক্ত করতে হবে। তুমি
মৌলিক টেমপ্লেট নথি নিশ্চিত করার জন্য দায়ী (যার মধ্যে ব্যক্তি
typedef ডকুমেন্টেশন ঢোকানো হয়) আপনি চান অন্যান্য সমস্ত তথ্য রয়েছে, কিন্তু হিসাবে
একটি সুবিধার জন্য autogsdoc একটি সাধারণ টেমপ্লেট তৈরি করবে (যা আপনি তখন সম্পাদনা করতে পারেন)
আপনি যদি ফাইলটি বিদ্যমান না থাকে। সন্নিবেশ আগে অবিলম্বে সঞ্চালিত হয় পিছনে
উপাদান (বা যদি এটি বিদ্যমান না থাকে, অবিলম্বে শেষের আগে শরীর উপাদান) মধ্যে
টেমপ্লেট

Up জেনারেট করা GSDoc থেকে 'আপ' লিঙ্কে ব্যবহার করার জন্য নাম সরবরাহ করতে ব্যবহৃত একটি স্ট্রিং
নথিপত্র এটি সাধারণত একটি ফাইলের নাম হওয়া উচিত যাতে একটি সূচক থাকে৷
একটি প্রকল্পের বিষয়বস্তু। যদি এটি অনুপস্থিত থাকে বা একটি খালি স্ট্রিং সেট করা হয়, তাহলে 'আপ' নেই
লিঙ্ক নথি প্রদান করা হবে.

ভেরিয়েবল টেমপ্লেট
একটি টেমপ্লেট নথির নাম উল্লেখ করুন যার মধ্যে ভেরিয়েবল সম্পর্কে ডকুমেন্টেশন রয়েছে
প্রকল্পের সমস্ত ফাইল থেকে সন্নিবেশ করা উচিত। পরিবর্তনশীল উৎস হলে এটি দরকারী
কোড অনেক ফাইলের চারপাশে ছড়িয়ে ছিটিয়ে আছে, এবং আপনাকে এটিকে এক জায়গায় গ্রুপ করতে হবে। তুমি
মৌলিক টেমপ্লেট নথি নিশ্চিত করার জন্য দায়ী (যার মধ্যে ব্যক্তি
পরিবর্তনশীল ডকুমেন্টেশন সন্নিবেশ করা হয়) আপনি চান অন্যান্য সমস্ত তথ্য রয়েছে, কিন্তু
একটি সুবিধা হিসাবে autogsdoc একটি সাধারণ টেমপ্লেট তৈরি করবে (যা আপনি তখন সম্পাদনা করতে পারেন)
আপনার জন্য যদি ফাইলটি বিদ্যমান না থাকে। সন্নিবেশ আগে অবিলম্বে সঞ্চালিত হয় পিছনে
উপাদান (বা যদি এটি বিদ্যমান না থাকে, অবিলম্বে শেষের আগে শরীর উপাদান) মধ্যে
টেমপ্লেট

বাগাড়ম্বরপূর্ণ
আপনি ভার্বোস ডিবাগ/সতর্কতা আউটপুট হতে চান কিনা তা নির্দিষ্ট করতে ব্যবহৃত একটি বুলিয়ান
উত্পাদিত।

সাবধান করুন
আপনি স্ট্যান্ডার্ড সতর্কতা আউটপুট চান কিনা তা নির্দিষ্ট করতে একটি বুলিয়ান ব্যবহৃত হয় (যেমন রিপোর্ট
অনথিভুক্ত পদ্ধতি) উত্পাদিত।

ওয়ার্ডম্যাপ
এই মানটি উৎস ফাইলে পাওয়া শনাক্তকারী/কীওয়ার্ড ম্যাপ করতে ব্যবহৃত একটি অভিধান
অন্য কথায় সাধারণত আপনাকে এটি ব্যবহার করতে হবে না, তবে এটি কখনও কখনও সহায়ক হয়
সি প্রিপ্রসেসর ম্যাক্রো ব্যবহার করে পার্সারকে বিভ্রান্ত করা এড়াতে। তুমি পারবে
কার্যকরভাবে ম্যাক্রোকে কম বিভ্রান্তিকর কিছুতে পুনরায় সংজ্ঞায়িত করুন। মান আপনি মানচিত্র
শনাক্তকারীর একটি হতে হবে - আরেকটি শনাক্তকারী, একটি খালি স্ট্রিং - মান হল
উপেক্ষা করা হয়েছে, দুটি স্ল্যাশ ('//') - বাকি লাইন উপেক্ষা করা হয়েছে। উল্লেখ্য যে একটি অভিধান
স্ট্যান্ডার্ড প্রপার্টিলিস্ট ফরম্যাট ব্যবহার করে কমান্ড লাইনে দেওয়া যেতে পারে (না
OS X-এর XML বিন্যাস), সেমিকোলনকে লাইন-বিভাজক হিসাবে ব্যবহার করে এবং এটিকে এককভাবে আবদ্ধ করে
কোট।

আন্তঃ নথিপত্র LINKAGE

'আপ' ডিফল্টটি একটি নথির নাম নির্দিষ্ট করতে ব্যবহৃত হয় যা হিসাবে ব্যবহার করা উচিত
ব্যবহৃত অন্য কোনো নথির জন্য 'আপ' লিঙ্ক। এই নামটি অবশ্যই একটি পথ বা এক্সটেনশন অন্তর্ভুক্ত করবে না৷
সাধারণত, এই ডিফল্ট দ্বারা উল্লেখ করা নথিটি একটি হাতে-সম্পাদিত GSDoc নথি হওয়া উচিত
যা একটি প্রকল্প সূচক ধারণকারী একটি পিছনে অংশ থাকা উচিত. যেমন


<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.3//EN"
"http://www.gnustep.org/gsdoc-1_0_3.xml">


আমার প্রকল্পের রেফারেন্স




আমার প্রকল্পের রেফারেন্স

onworks.net পরিষেবা ব্যবহার করে অনলাইনে autogsdoc ব্যবহার করুন