কীভাবে ডক্সিজেন দিয়ে একটি পরিচিতি পৃষ্ঠা তৈরি করবেন

102

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

doxygen 
— অ্যালেক্স এফ
সূত্র
2
— parasrish

উত্তর:

95

কটাক্ষপাত আছে mainpageকমান্ড।

এছাড়াও, অন্য থ্রেডের এই উত্তরটি দেখুন: কীভাবে কাস্টম ফাইলগুলিকে ডক্সিজেনে অন্তর্ভুক্ত করা যায় । এটা তোলে যুক্তরাষ্ট্রের তিন এক্সটেনশন যা অতিরিক্ত ডকুমেন্টেশন ফাইল হিসেবে শ্রেণীর doxygen আছে: .dox, .txtএবং .doc। এই এক্সটেনশনগুলির সাথে ফাইলগুলি ফাইল সূচীতে উপস্থিত হয় না তবে এটি আপনার চূড়ান্ত ডকুমেন্টেশনের অতিরিক্ত তথ্য অন্তর্ভুক্ত করার জন্য ব্যবহার করা যেতে পারে - প্রয়োজনীয় ডকুমেন্টেশনের জন্য খুব দরকারী তবে এটি আপনার উত্স কোডের সাথে অন্তর্ভুক্ত করা সত্যিই উপযুক্ত নয় (উদাহরণস্বরূপ, একটি FAQ)

সুতরাং আমি mainpage.doxআপনাকে এসডিকে পরিচয় করানোর জন্য আপনার প্রকল্প ডিরেক্টরিতে একটি (বা অনুরূপ নামযুক্ত) ফাইল রাখার পরামর্শ দিচ্ছি । নোট করুন যে এই ফাইলটির ভিতরে আপনার এক বা একাধিক সি / সি ++ স্টাইলের মন্তব্য ব্লক স্থাপন করা দরকার।

— ক্রিস
সূত্র
3
কমপক্ষে মার্কডাউন ফাইলগুলি ( .mdএবং .markdown) পাশাপাশি অতিরিক্ত ডকুমেন্টেশন ফাইল হিসাবে বিবেচিত হয়। আমি তাদের চেয়ে বেশি পছন্দ করি .doxকারণ তাদের আশেপাশের কোড কমেন্টের প্রয়োজন নেই এবং কোনও চিহ্ন ছাড়াই - মার্কডাউন সম্পাদক দিয়ে সুন্দরভাবে সম্পাদনা করা যেতে পারে।
— পাসকাল
56

V1.8.8 হিসাবে বিকল্প আছে USE_MDFILE_AS_MAINPAGE। সুতরাং আপনার সূচী ফাইলটি যেমন README.md , এ যুক্ত করার বিষয়টি নিশ্চিত করুন INPUTএবং এটিকে এই বিকল্পের মান হিসাবে সেট করুন:

INPUT += README.md
USE_MDFILE_AS_MAINPAGE = README.md
— প্যাসকেল
সূত্র
4
এগুলি ছাড়াও, যদি আপনি README.md কে মূল পৃষ্ঠা হিসাবে ব্যবহার করতে চলেছেন তবে নিশ্চিত হন যে এটি ইনপুট তালিকায় প্রথম আসে। যখন একাধিক মেইনপেজ প্রার্থী থাকে, পার্সিংয়ের সময় প্রথমটি নির্বাচিত হয় বা তাই মনে হয়।
— লেস্টার পিয়াবডি
2
যাইহোক, অক্সিজেন গুইতে আপনাকে কেবল নিজের .md ফাইলটি বিশেষজ্ঞ> ইনপুট> ইনপুট এর অন্তর্ভুক্ত করতে হবে।
— অ্যাড্রিয়ান লোপেজ
USE_MDFILE_AS_MAINPAGEআমার জন্য কাজ করে না। ডকুমেন্টেশন অনুসারে, আপনাকে {#mainpage}মার্কডাউন ডকুমেন্টের শিরোনামের পরে অন্তর্ভুক্ত করতে হবে। এটি কাজ করে।
— samvv
2
@ সামভভি আমি মার্কডাউন ডকুমেন্টে কোনও অতিরিক্ত যোগ করিনি। আমি শুধু ব্যবহার করা INPUT = README.mdতারপর INPUT += src(অনুসরণ করতে @ লেস্টার এর পরামর্শ) এবং USE_MDFILE_AS_MAINPAGE = README.mdএবং এটি একটি যাদুমন্ত্র মত কাজ করেন। সংস্করণ: আমার কাছে $ doxygen --versionফিরে আসে 1.8.11।
— জাভি মন্টেরো
1
অক্সিজেন 1.8.2 এ, কাজটি কেবলমাত্র কাজটিই \mainpageভিতরে যুক্ত করা হচ্ছে (কোনও মন্তব্যে এটি করতে পারেন ( মার্কডাউনে মন্তব্যগুলি সম্পর্কে এই লিঙ্কটি দেখুন ) This এটি এখনও স্থানধারক (খালি) সহ সম্পর্কিত পৃষ্ঠাগুলি তৈরি করেছে। এটি বিরক্তিকর, তবে কমপক্ষে আমি মূল পৃষ্ঠাটি পেয়েছি
— ইভেন
55

নোট করুন যে অক্সিজেন প্রকাশিত 1.8.0 এর সাথে আপনি মার্কডাউন ফর্ম্যাটেড পৃষ্ঠাগুলিও যুক্ত করতে পারেন। এটি কাজ করার জন্য আপনাকে একটি .mdবা .markdownএক্সটেনশন দিয়ে পৃষ্ঠা তৈরি করতে হবে এবং কনফিগার ফাইলে নিম্নলিখিতগুলি যুক্ত করতে হবে:

INPUT += your_page.md
FILE_PATTERNS += *.md *.markdown

বিশদ জানতে http://www.do ऑक्सी ণ.এনএল / ম্যানুয়াল / মার্কডাউন। Html# md_page_header দেখুন ।

— doxygen
সূত্র
6
প্রকৃতপক্ষে বর্তমান 1.8.0 সংস্করণ সমর্থন মার্কডাউন বিট তাদের ডকুমেন্টেশন হিসাবে বিবেচনা করে না। সুতরাং আপনি ফাইল এবং ডিরেক্টরি বিভাগে তালিকাভুক্ত মার্কডাউন ক্লাস শেষ করবেন। সমাধানটি হ'ল dox=mdএকটি হিসাবে যুক্ত করা EXTENSION_MAPPINGএবং আপনার মার্কডাউন এক্সটেনশনের নাম পরিবর্তন করতে। .doxতাই কনফিগারেশনটি দেখতে পাবেন:INPUT += your_page.dox EXTENSION_MAPPING += dox=md
— অ্যান্টিটক্সিক
6
ভাল যুক্তি. আমি এটিকে সংশোধন করব। এমডি এবং .মার্কডাউন .ডক্সের সাথে একইরকম আচরণ করা হয়।
— ডোজিজেন
4
দুর্ভাগ্যক্রমে, এটি মূল পৃষ্ঠাগুলি হিসাবে নয়, সম্পর্কিত পৃষ্ঠাগুলির অধীনে শেষ হয়
— ইভজেন
7

নিম্নলিখিত বাক্য গঠনটি ডোজিজেনের জন্য একটি প্রধান পৃষ্ঠা এবং সম্পর্কিত উপ পৃষ্ঠা যুক্ত করতে সহায়তা করতে পারে:

/*! \mainpage Drawing Shapes
 *
 * This project helps user to draw shapes.
 * Currently two types of shapes can be drawn:
 * - \subpage drawingRectanglePage "How to draw rectangle?"
 *
 * - \subpage drawingCirclePage "How to draw circle?"
 *
 */ 

/*! \page drawingRectanglePage How to draw rectangle?
 *
 * Lorem ipsum dolor sit amet
 *
 */

/*! \page drawingCirclePage How to draw circle?
 *
 * This page is about how to draw a circle.
 * Following sections describe circle:
 * - \ref groupCircleDefinition "Definition of Circle"
 * - \ref groupCircleClass "Circle Class"
 */

নিম্নলিখিত হিসাবে গোষ্ঠী তৈরি করা পৃষ্ঠাগুলি ডিজাইনের ক্ষেত্রেও সহায়তা করে: 

/** \defgroup groupCircleDefinition Circle Definition
 * A circle is a simple shape in Euclidean geometry.
 * It is the set of all points in a plane that are at a given distance from a given point, the centre;
 * equivalently it is the curve traced out by a point that moves so that its distance from a given point is constant.
 * The distance between any of the points and the centre is called the radius.
 */

একটি উদাহরণ এখানে পাওয়া যাবে

— বিরল কপা
সূত্র
@ ফেলিক্স এসএফডি আপনার মতামতের জন্য আপনাকে ধন্যবাদ। আপনার উত্তর অনুসারে আমি আমার উত্তর আপডেট করেছি।
— বিরল কপা
5

ডকুমেন্টেশনে এমন কোনও ফাইল যুক্ত করুন যাতে আপনার সামগ্রী অন্তর্ভুক্ত করবে, উদাহরণস্বরূপ toc.h :

@ mainpage Manual SDK
<hr/>
@ section pageTOC Content
  -# @ref Description
  -# @ref License
  -# @ref Item
...

এবং আপনার Doxyfile:

INPUT = toc.h \

উদাহরণ (রাশিয়ান)

— ডেনিস
সূত্র
1
স্কেল-টেক লিঙ্কগুলি এখন মারা গেছে।
— বেন ফুলটন 21
3

আমি উপরের সমস্তটি 1.8.13 ভি দিয়ে চেষ্টা করেও কোনও লাভ হয়নি। আমার জন্য ম্যাকস (ম্যাকোএসে) যা কাজ করেছিল সেটি হ'ল ডক্সিউইজার্ড-> বিশেষজ্ঞ ট্যাগটি USE_MD_FILE_AS_MAINPAGEসেটিংটি পূরণ করতে ।

এটি আমার ডক্সিফাইলে নিম্নলিখিত পরিবর্তনগুলি করেছে:

USE_MDFILE_AS_MAINPAGE = ../README.md
...
INPUT                  = ../README.md \
                         ../sdk/include \
                         ../sdk/src

লাইন সমাপ্তির জন্য নোট করুন INPUT, আমি ডকুমেন্টেশনে উল্লিখিত হিসাবে পৃথককারী হিসাবে সবেমাত্র স্থানটি ব্যবহার করেছি। এএএএফআইসিটি হ'ল ডক্সিফিলের না-কাজ করা এবং কার্যকারী সংস্করণের মধ্যে এটিই একমাত্র পরিবর্তন।

— VorpalSword
সূত্র
1
স্পেসিফিকেশন - ডক্সিউইজার্ড হ'ল জিইউআই ফ্রন্ট এন্ড যা ম্যাকোজে ইনস্টল করে।
— ভোরপালসার্ড
মূল পৃষ্ঠা হিসাবে স্বীকৃতি পেতে README.md পেতে আমাকে \ মূল পৃষ্ঠাটি যুক্ত করতে হয়েছিল
— জেবাকজুক
আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.